sal/osl/unx/file_error_transl.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _FILE_ERROR_TRANSL_H_
  30 #define _FILE_ERROR_TRANSL_H_
  31
  32 #include <osl/file.h>
  33 #include <sal/types.h>
  34
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #endif
  39
  40 /*********************************************
  41    oslTranslateFileError
  42    Translate errno's to osl file errors
  43
  44    @param bIsError [in] specifies if nErrno
  45            should be interpreted as error,
  46           some libc functions signaling an error
  47            but errno is nevertheless 0 in this
  48            case the function should at least
  49            return osl_File_E_Unknown but in no
  50            case osl_File_E_None!
  51
  52    @param nErrno [in] the errno if errno is 0
  53             and bIsError is true the function
  54            returns osl_File_E_Unknown
  55
  56    @returns the osl error code appropriate to
  57               the errno
  58
  59  *********************************************/
  60
  61 #define OSL_FET_SUCCESS sal_False
  62 #define OSL_FET_ERROR   sal_True
  63
  64 oslFileError oslTranslateFileError(sal_Bool bIsError, int Errno);
  65
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */