Back to index

lightning-sunbird  0.9+nobinonly
nssbase.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is the Netscape security libraries.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 1994-2000
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #ifndef NSSBASE_H
00038 #define NSSBASE_H
00039 
00040 #ifdef DEBUG
00041 static const char NSSBASE_CVS_ID[] = "@(#) $RCSfile: nssbase.h,v $ $Revision: 1.3 $ $Date: 2005/01/20 02:25:45 $";
00042 #endif /* DEBUG */
00043 
00044 /*
00045  * nssbase.h
00046  *
00047  * This header file contains the prototypes of the basic public
00048  * NSS routines.
00049  */
00050 
00051 #ifndef NSSBASET_H
00052 #include "nssbaset.h"
00053 #endif /* NSSBASET_H */
00054 
00055 PR_BEGIN_EXTERN_C
00056 
00057 /*
00058  * NSSArena
00059  *
00060  * The public methods relating to this type are:
00061  *
00062  *  NSSArena_Create  -- constructor
00063  *  NSSArena_Destroy
00064  */
00065 
00066 /*
00067  * NSSArena_Create
00068  *
00069  * This routine creates a new memory arena.  This routine may return
00070  * NULL upon error, in which case it will have created an error stack.
00071  *
00072  * The top-level error may be one of the following values:
00073  *  NSS_ERROR_NO_MEMORY
00074  *
00075  * Return value:
00076  *  NULL upon error
00077  *  A pointer to an NSSArena upon success
00078  */
00079 
00080 NSS_EXTERN NSSArena *
00081 NSSArena_Create
00082 (
00083   void
00084 );
00085 
00086 extern const NSSError NSS_ERROR_NO_MEMORY;
00087 
00088 /*
00089  * NSSArena_Destroy
00090  *
00091  * This routine will destroy the specified arena, freeing all memory
00092  * allocated from it.  This routine returns a PRStatus value; if 
00093  * successful, it will return PR_SUCCESS.  If unsuccessful, it will
00094  * create an error stack and return PR_FAILURE.
00095  *
00096  * The top-level error may be one of the following values:
00097  *  NSS_ERROR_INVALID_ARENA
00098  *
00099  * Return value:
00100  *  PR_SUCCESS upon success
00101  *  PR_FAILURE upon failure
00102  */
00103 
00104 NSS_EXTERN PRStatus
00105 NSSArena_Destroy
00106 (
00107   NSSArena *arena
00108 );
00109 
00110 extern const NSSError NSS_ERROR_INVALID_ARENA;
00111 
00112 /*
00113  * The error stack
00114  *
00115  * The public methods relating to the error stack are:
00116  *
00117  *  NSS_GetError
00118  *  NSS_GetErrorStack
00119  */
00120 
00121 /*
00122  * NSS_GetError
00123  *
00124  * This routine returns the highest-level (most general) error set
00125  * by the most recent NSS library routine called by the same thread
00126  * calling this routine.
00127  *
00128  * This routine cannot fail.  It may return NSS_ERROR_NO_ERROR, which
00129  * indicates that the previous NSS library call did not set an error.
00130  *
00131  * Return value:
00132  *  0 if no error has been set
00133  *  A nonzero error number
00134  */
00135 
00136 NSS_EXTERN NSSError
00137 NSS_GetError
00138 (
00139   void
00140 );
00141 
00142 extern const NSSError NSS_ERROR_NO_ERROR;
00143 
00144 /*
00145  * NSS_GetErrorStack
00146  *
00147  * This routine returns a pointer to an array of NSSError values, 
00148  * containingthe entire sequence or "stack" of errors set by the most 
00149  * recent NSS library routine called by the same thread calling this 
00150  * routine.  NOTE: the caller DOES NOT OWN the memory pointed to by 
00151  * the return value.  The pointer will remain valid until the calling 
00152  * thread calls another NSS routine.  The lowest-level (most specific) 
00153  * error is first in the array, and the highest-level is last.  The 
00154  * array is zero-terminated.  This routine may return NULL upon error; 
00155  * this indicates a low-memory situation.
00156  *
00157  * Return value:
00158  *  NULL upon error, which is an implied NSS_ERROR_NO_MEMORY
00159  *  A NON-caller-owned pointer to an array of NSSError values
00160  */
00161 
00162 NSS_EXTERN NSSError *
00163 NSS_GetErrorStack
00164 (
00165   void
00166 );
00167 
00168 PR_END_EXTERN_C
00169 
00170 #endif /* NSSBASE_H */