sal/osl/os2/file_error_transl.h

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