IsUserError - cBaseErrorHandler

Determines if an error belongs to the set of user (handled) errors

Type: Function
Return Data Type: Boolean

Parameters

Parameter	Type	Description
iError	Integer	Error number

Syntax

Function IsUserError Integer iError Returns Boolean

Call Example

Get IsUserError iError to BooleanVariable

Description

The error system categorizes errors as a user error (handled) or a program error (unhandled). If an error is part of the user error list, it will be treated as a user error. Call IsUserError to test whether a particular error number is registered as a user (handled) error.

Sample

This sample sample tests whether error number 300 is registered as a user (handled) error.

If (IsUserError (ghoErrorHandler, 300)) Begin
    // do something
End

Return Value

Returns True if the passed error number belongs to the set of user (handled) errors.