formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Basic

# fzrt_error_get_info

Description

Gets information on a error. This will return information about the error ID, including the error ID, and error string, the severity of the error, the Context of the error and the context ID within the context, the name of the context, if any, and any specific detail ID.

Plugin Prototype

fzrt_boolean fzrt_error_get_info(

fzrt_error_td | err_id,
char * | str,
fzrt_int | maxlen,
fzrt_int * | err,
fzrt_error_severity_enum * | severity,
fzrt_error_context_enum * | context,
fzrt_int * | context_id,
char * | context_id_name,
fzrt_int | context_id_name_len,
fzrt_int * | detail_id )

Parameters

err_id [Input]

The error ID to get information about.

str [Input, Optional]

pointer to buffer to receive string, NULL if not needed

maxlen [Input, Optional]

size of buffer to receive string, ignored if str is NULL

err [Input, Optional]

pointer to fzrt_int to receive actual error ID, NULL if not needed

severity [Input, Optional]

pointer to fzrt_error_severity_enum to receive severity, NULL if not needed

context [Input, Optional]

pointer to fzrt_error_context_enum to receive context, NULL if not needed

context_id [Input, Optional]

pointer to fzrt_int to receive context id, NULL if not needed

context_id_name [Input, Optional]

pointer to buffer to receive context name, NULL if not needed

context_id_name_len [Input, Optional]

size of buffer for context name, ignored if context_id_name is NULL

detail_id [Input, Optional]

pointer to fzrt_int to receive detail id, NULL if not needed

Returns

FALSE if successful, TRUE if error is invalid or if a string can't be found for the error.

Availability

5.0.0.0

Function Set

fz_fzrt_base_fset

Defined in

fzrt_api.h