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