src/libs/common/strerror_r.h

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2011 aMule Team ( admin@amule.org / http://www.amule.org )
   5 //
   6 // Any parts of this program derived from the xMule, lMule or eMule project,
   7 // or contributed by third-party developers are copyrighted by their
   8 // respective authors.
   9 //
  10 // This program is free software; you can redistribute it and/or modify
  11 // it under the terms of the GNU General Public License as published by
  12 // the Free Software Foundation; either version 2 of the License, or
  13 // (at your option) any later version.
  14 //
  15 // This program 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 General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  23 //
  24
  25 #ifndef MULE_STRERROR_R_H
  26 #define MULE_STRERROR_R_H
  27
  28 /**
  29  * Return string describing error number.
  30  *
  31  * This function implements the XSI-compliant strerror_r() function whenever
  32  * it's possible. Also it is thread safe if there is a thread-safe function
  33  * to get the error description.
  34  *
  35  * @param errnum Error number for which the description is needed.
  36  * @param buf    Buffer to store the error description.
  37  * @param buflen Length of the buffer.
  38  *
  39  * @return 0 on success; on error, -1 is returned and errno is set to indicate
  40  *         the error.
  41  */
  42 extern "C" int mule_strerror_r(int errnum, char *buf, size_t buflen);
  43
  44 #endif /* MULE_STRERROR_R_H */