sal/osl/os2/file_error_transl.h

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