nssbase.h
上传用户:lyxiangda
上传日期:2007-01-12
资源大小:3042k
文件大小:4k
源码类别:

CA认证

开发平台:

WINDOWS

  1. /* 
  2.  * The contents of this file are subject to the Mozilla Public
  3.  * License Version 1.1 (the "License"); you may not use this file
  4.  * except in compliance with the License. You may obtain a copy of
  5.  * the License at http://www.mozilla.org/MPL/
  6.  * 
  7.  * Software distributed under the License is distributed on an "AS
  8.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  9.  * implied. See the License for the specific language governing
  10.  * rights and limitations under the License.
  11.  * 
  12.  * The Original Code is the Netscape security libraries.
  13.  * 
  14.  * The Initial Developer of the Original Code is Netscape
  15.  * Communications Corporation.  Portions created by Netscape are 
  16.  * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
  17.  * Rights Reserved.
  18.  * 
  19.  * Contributor(s):
  20.  * 
  21.  * Alternatively, the contents of this file may be used under the
  22.  * terms of the GNU General Public License Version 2 or later (the
  23.  * "GPL"), in which case the provisions of the GPL are applicable 
  24.  * instead of those above.  If you wish to allow use of your 
  25.  * version of this file only under the terms of the GPL and not to
  26.  * allow others to use your version of this file under the MPL,
  27.  * indicate your decision by deleting the provisions above and
  28.  * replace them with the notice and other provisions required by
  29.  * the GPL.  If you do not delete the provisions above, a recipient
  30.  * may use your version of this file under either the MPL or the
  31.  * GPL.
  32.  */
  33. #ifndef NSSBASE_H
  34. #define NSSBASE_H
  35. #ifdef DEBUG
  36. static const char NSSBASE_CVS_ID[] = "@(#) $RCSfile: nssbase.h,v $ $Revision: 1.1 $ $Date: 2000/03/31 19:50:22 $ $Name: NSS_3_1_1_RTM $";
  37. #endif /* DEBUG */
  38. /*
  39.  * nssbase.h
  40.  *
  41.  * This header file contains the prototypes of the basic public
  42.  * NSS routines.
  43.  */
  44. #ifndef NSSBASET_H
  45. #include "nssbaset.h"
  46. #endif /* NSSBASET_H */
  47. PR_BEGIN_EXTERN_C
  48. /*
  49.  * NSSArena
  50.  *
  51.  * The public methods relating to this type are:
  52.  *
  53.  *  NSSArena_Create  -- constructor
  54.  *  NSSArena_Destroy
  55.  */
  56. /*
  57.  * NSSArena_Create
  58.  *
  59.  * This routine creates a new memory arena.  This routine may return
  60.  * NULL upon error, in which case it will have created an error stack.
  61.  *
  62.  * The top-level error may be one of the following values:
  63.  *  NSS_ERROR_NO_MEMORY
  64.  *
  65.  * Return value:
  66.  *  NULL upon error
  67.  *  A pointer to an NSSArena upon success
  68.  */
  69. NSS_EXTERN NSSArena *
  70. NSSArena_Create
  71. (
  72.   void
  73. );
  74. extern const NSSError NSS_ERROR_NO_MEMORY;
  75. /*
  76.  * NSSArena_Destroy
  77.  *
  78.  * This routine will destroy the specified arena, freeing all memory
  79.  * allocated from it.  This routine returns a PRStatus value; if 
  80.  * successful, it will return PR_SUCCESS.  If unsuccessful, it will
  81.  * create an error stack and return PR_FAILURE.
  82.  *
  83.  * The top-level error may be one of the following values:
  84.  *  NSS_ERROR_INVALID_ARENA
  85.  *
  86.  * Return value:
  87.  *  PR_SUCCESS upon success
  88.  *  PR_FAILURE upon failure
  89.  */
  90. NSS_EXTERN PRStatus
  91. NSSArena_Destroy
  92. (
  93.   NSSArena *arena
  94. );
  95. extern const NSSError NSS_ERROR_INVALID_ARENA;
  96. /*
  97.  * The error stack
  98.  *
  99.  * The public methods relating to the error stack are:
  100.  *
  101.  *  NSS_GetError
  102.  *  NSS_GetErrorStack
  103.  */
  104. /*
  105.  * NSS_GetError
  106.  *
  107.  * This routine returns the highest-level (most general) error set
  108.  * by the most recent NSS library routine called by the same thread
  109.  * calling this routine.
  110.  *
  111.  * This routine cannot fail.  It may return NSS_ERROR_NO_ERROR, which
  112.  * indicates that the previous NSS library call did not set an error.
  113.  *
  114.  * Return value:
  115.  *  0 if no error has been set
  116.  *  A nonzero error number
  117.  */
  118. NSS_EXTERN NSSError
  119. NSS_GetError
  120. (
  121.   void
  122. );
  123. extern const NSSError NSS_ERROR_NO_ERROR;
  124. /*
  125.  * NSS_GetErrorStack
  126.  *
  127.  * This routine returns a pointer to an array of NSSError values, 
  128.  * containingthe entire sequence or "stack" of errors set by the most 
  129.  * recent NSS library routine called by the same thread calling this 
  130.  * routine.  NOTE: the caller DOES NOT OWN the memory pointed to by 
  131.  * the return value.  The pointer will remain valid until the calling 
  132.  * thread calls another NSS routine.  The lowest-level (most specific) 
  133.  * error is first in the array, and the highest-level is last.  The 
  134.  * array is zero-terminated.  This routine may return NULL upon error; 
  135.  * this indicates a low-memory situation.
  136.  *
  137.  * Return value:
  138.  *  NULL upon error, which is an implied NSS_ERROR_NO_MEMORY
  139.  *  A NON-caller-owned pointer to an array of NSSError values
  140.  */
  141. NSS_EXTERN NSSError *
  142. NSS_GetErrorStack
  143. (
  144.   void
  145. );
  146. PR_END_EXTERN_C
  147. #endif /* NSSBASE_H */