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

# fzrt_error_get_string

Description

Gets a string associated with an error. This will return a string suitable for display, for the specified error ID.

Plugin Prototype

fzrt_boolean fzrt_error_get_string(

fzrt_error_td | err_id,
char * | str,
fzrt_int | maxlen )

Parameters

err_id [Input]

Error ID

str [Input]

pointer to buffer to receive the error

maxlen [Input]

Size of the string buffer

Returns

FALSE if successful, TRUE if err id is not valid, or context does supply strings for errors..

Availability

5.0.0.0

Function Set

fz_fzrt_base_fset

Defined in

fzrt_api.h