---

XSECCryptoException Class Reference
[Cryptographic Abstraction Layer]

Exception class used by the cryptographic modules. More...

#include <XSECCryptoException.hpp>

List of all members.

Public Types
enum	XSECCryptoExceptionType {   None = 0,   MDError = 1,   Base64Error = 2,   MemoryError = 3,   X509Error = 4,   DSAError = 5,   RSAError = 6,   UnknownError = 7 }
	Defines the error type. More...
Public Methods
XSECCryptoExceptionType	getType (void)
	Get the error type. More...
Contructors and Destructors
	XSECCryptoException (XSECCryptoExceptionType eNum, char *inMsg=NULL)
	Common constructur. More...
	XSECCryptoException (XSECCryptoExceptionType eNum, safeBuffer &inMsg)
	safeBuffer constructor. More...
	XSECCryptoException (const XSECCryptoException &toCopy)
	Copy Constructor. More...
	~XSECCryptoException ()
Get Methods
const char *	getMsg (void)
	Get the message. More...

---

Detailed Description

Exception class used by the cryptographic modules.

This exception class should be used by the Cryptographic providers for reporting errors.

It's a fairly standard exception class, with a type parameter (and associated enumerated type) and a string that can be used to provide more information to the caller.

---

Member Enumeration Documentation

enum XSECCryptoException::XSECCryptoExceptionType

Defines the error type. Enumerated type that can be looked up by the receiver of the exception to determine what the error was. Can also be used as a lookup into the XSECCryptoExceptionStrings global array for a default error description Enumeration values: None  MDError  Base64Error  MemoryError  X509Error  DSAError  RSAError  UnknownError

---

Constructor & Destructor Documentation

XSECCryptoException::XSECCryptoException (  XSECCryptoExceptionType    eNum, char *    inMsg = NULL )

Common constructur. Construct an exception with the given type and (possibly blank) message. Parameters: eNum  The error type inMsg  The message to be passed to the caller. If NULL this will be set to the associated value in XSECCryptoExceptionStrings

XSECCryptoException::XSECCryptoException (  XSECCryptoExceptionType    eNum, safeBuffer &    inMsg )

safeBuffer constructor. As for the common constructor, but passes in a safeBuffer message Parameters: eNum  The error type inMsg  The message string to be passed to the caller.

XSECCryptoException::XSECCryptoException (  const XSECCryptoException &    toCopy )

Copy Constructor. Parameters: toCopy  The exception to be copied into the new exception

XSECCryptoException::~XSECCryptoException (    )

---

Member Function Documentation

const char* XSECCryptoException::getMsg (  void    )

Get the message. Allows the receiver of the exception to get the error message. Returns: A pointer to the char buffer holding the error string

XSECCryptoExceptionType XSECCryptoException::getType (  void    )

Get the error type. Returns: The error type of the error that caused the exception

---

The documentation for this class was generated from the following file:

• XSECCryptoException.hpp

---