pnExceptionSet

raise an exception

Synopsis

void pnExceptionSet();

Description

pnExceptionSet() allows a function to raise an exception. The caller must supply a value for the major parameter. The major parameter can have one of the values PN_NO_EXCEPTION, PN_USER_EXCEPTION, or PN_SYSTEM_EXCEPTION. The value of the major parameter constrains the other parameters in the call as follows:

• If the major parameter has the value PN_NO_EXCEPTION, this is a normal outcome to the operation. In this case, both exception_id and param must be NULL. Note that it is not necessary to invoke pnExceptionSet() to indicate a normal outcome; it is the default behavior if the method simply returns.

• For any other value of major it specifies either a user-defined or system exception. The exception_id parameter is the identifier representing the exception type. If the exception is declared to have members, the param parameter must be the exception struct (PHP class) containing the members. If the exception has no members, param must be NULL.

Return Values

This function does not return a value.

See Also

pnExceptionFree(), pnExceptionId(), pnExceptionMajor(), pnExceptionValue()