sal/osl/unx/file_error_transl.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _FILE_ERROR_TRANSL_H_
  21 #define _FILE_ERROR_TRANSL_H_
  22
  23 #include <osl/file.h>
  24 #include <sal/types.h>
  25
  26 #ifdef __cplusplus
  27 extern "C"
  28 {
  29 #endif
  30
  31 /*********************************************
  32    oslTranslateFileError
  33    Translate errno's to osl file errors
  34
  35    @param bIsError [in] specifies if nErrno
  36            should be interpreted as error,
  37           some libc functions signaling an error
  38            but errno is nevertheless 0 in this
  39            case the function should at least
  40            return osl_File_E_Unknown but in no
  41            case osl_File_E_None!
  42
  43    @param nErrno [in] the errno if errno is 0
  44             and bIsError is true the function
  45            returns osl_File_E_Unknown
  46
  47    @returns the osl error code appropriate to
  48               the errno
  49
  50  *********************************************/
  51
  52 #define OSL_FET_SUCCESS sal_False
  53 #define OSL_FET_ERROR   sal_True
  54
  55 oslFileError oslTranslateFileError(sal_Bool bIsError, int Errno);
  56
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */