/gecko_api/include/nssbase.h

http://firefox-mac-pdf.googlecode.com/ · C Header · 170 lines · 34 code · 20 blank · 116 comment · 0 complexity · fbe6443f5de084bfdd6f68cfd1f68d0e MD5 · raw file

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