gecko/security/nss/lib/util/nssutil.h
Kai Engert a37ca8f2ef Bug 669061, Upgrade to NSS 3.13, starting with NSS_3_13_BETA1, r=wtc
--HG--
rename : security/nss/cmd/lib/SSLerrs.h => security/nss/lib/ssl/SSLerrs.h
rename : security/nss/cmd/lib/SECerrs.h => security/nss/lib/util/SECerrs.h
2011-08-19 17:27:10 +02:00

123 lines
4.2 KiB
C

/*
* NSS utility functions
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Network Security Services.
*
* The Initial Developer of the Original Code is
* Red Hat Inc.
* Portions created by the Initial Developer are Copyright (C) 2009
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef __nssutil_h_
#define __nssutil_h_
#ifndef RC_INVOKED
#include "prerror.h"
#include "seccomon.h"
#endif
/*
* NSS utilities's major version, minor version, patch level, build number,
* and whether this is a beta release.
*
* The format of the version string should be
* "<major version>.<minor version>[.<patch level>[.<build number>]][ <Beta>]"
*/
#define NSSUTIL_VERSION "3.13.0.0 Beta"
#define NSSUTIL_VMAJOR 3
#define NSSUTIL_VMINOR 13
#define NSSUTIL_VPATCH 0
#define NSSUTIL_VBUILD 0
#define NSSUTIL_BETA PR_TRUE
typedef enum {
formatSimple = 0,
formatIncludeErrorCode
} ReportFormatType;
SEC_BEGIN_PROTOS
/*
* Returns a const string of the UTIL library version.
*/
extern const char *NSSUTIL_GetVersion(void);
extern PRStatus
NSS_InitializePRErrorTable(void);
/* Returns a UTF-8 encoded constant error string for "errNum".
* Returns NULL if either initialization of the error tables
* or formatting fails due to insufficient memory.
*
* The format argument indicates whether extra error information
* is desired. This is useful when localizations are not yet
* available and the mapping would return nothing for a locale.
*
* Specify formatSimple to get just the error string as mapped.
* Specify formatIncludeErrorCode to format the error code
* numeric value plus a bracketed stringized error name
* preappended to the mapped error string.
*
* Additional formatting options may be added in teh future
*
* This string must not be modified by the application, but may be modified by
* a subsequent call to NSS_Perror() or NSS_Strerror().
*/
extern char *
NSS_Strerror(PRErrorCode errNum, ReportFormatType format);
/* NSS_StrerrorTS is a thread safe version of NSS_Strerror.
* It formats output into a buffer allocated at run time.
* The buffer is allocated with PR_smprintf thus the string
* returned should be freed with PR_smprintf_free.
*/
extern char *
NSS_StrerrorTS(PRErrorCode errNum, ReportFormatType format);
/* Prints an error message on the standard error output, describing the last
* error encountered during a call to an NSS library function.
*
* A language-dependent error message is written and formatted to the standard
* error stream as follows:
*
* If s is not a null pointer or empty, it prints the string pointed to
* by s followed by a colon and a space and then the error message string
* followed by a newline.
*/
extern void
NSS_Perror(const char *s, ReportFormatType format);
SEC_END_PROTOS
#endif /* __nssutil_h_ */