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

fzrt_error_set

Description

Sets the current error. This assigns a unique error ID to an error. The error ID can be returned to a calling function. The context and Context ID are used to make the error unique within the .

Plugin Prototype

fzrt_error_td fzrt_error_set(

fzrt_int

err,

fzrt_error_severity_enum

severity,

fzrt_error_context_enum

context,

fzrt_int

context_id )

Parameters

err [Input]

Specific error ID

severity [Input]

Severity of the error

context [Input]

The context of the error

context_id [Input]

the specific ID within the context, for plugins this is the plugin ID

Returns

The unique runtime error ID.

Availability

5.0.0.0

See Also

fzrt_error_set,

Function Set

fz_fzrt_base_fset


Defined in

fzrt_api.h