xref: /aoo41x/main/sal/osl/unx/file_error_transl.h (revision 9eab2a37)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef _FILE_ERROR_TRANSL_H_
25 #define _FILE_ERROR_TRANSL_H_
26 
27 #include <osl/file.h>
28 #include <sal/types.h>
29 
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34 
35 /*********************************************
36    oslTranslateFileError
37    Translate errno's to osl file errors
38 
39    @param bIsError [in] specifies if nErrno
40  		  should be interpreted as error,
41     	  some libc functions signaling an error
42  		  but errno is nevertheless 0 in this
43  		  case the function should at least
44  		  return osl_File_E_Unknown but in no
45  		  case osl_File_E_None!
46 
47    @param nErrno [in] the errno if errno is 0
48   		  and bIsError is true the function
49  		  returns osl_File_E_Unknown
50 
51    @returns the osl error code appropriate to
52   		    the errno
53 
54  *********************************************/
55 
56 #define OSL_FET_SUCCESS sal_False
57 #define OSL_FET_ERROR   sal_True
58 
59 oslFileError oslTranslateFileError(sal_Bool bIsError, int Errno);
60 
61 
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 #endif
67