Category Sketches and sections, Object ProSecerror

Function ProSecerrorAdd


Description
Adds a user-composed error to the errors table.
Synopsis
#include <ProSecerror.h>
ProErrorProSecerrorAdd(
ProWSecerror* PUserErr
/* (In)
The pointer to the errors table. You initialize this table using the function ProSecerrorAlloc().
*/
ProSecerrCode user_error
/* (In)
An integer code for a particular type of error.
*/
wchar_t* msg
/* (In)
A pointer to a user-created message in a wide (4 bytes per symbol) format. This input is not altered or released. If the input string exceeds the structure field, the function stores as many symbols as the field holds.
*/
ProSecerrSever user_severity
/* (In)
The assigned severity of the error.
*/
int user_ent_id
/* (In)
The identifier of the entity that generated the error.
*/
ProSecerrAttr user_attribute
/* (In)
The user-supplied attributes.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully added the new error to the table.
PRO_TK_BAD_INPUTSOne or more of the input arguments are invalid.
PRO_TK_OUT_OF_MEMORYThere was a memory error.
See Also
ProSecerrorAlloc

Manual References:

  1. Element Trees: Sections: Error Reporting
  2. Element Trees: Sections: Error Reporting

Sample Code References:

  1. pt_examples ( TestSecerr.c )
  2. pt_examples ( TestSect.c )
  3. pt_examples ( TestSect.c )
  4. pt_examples ( TestSect.c )
  5. pt_examples ( TestSect.c )