|
| ELZED | Documentation | The Details | API |
| lzDefineErrorThe lzDefineError function establishes an error code and its descriptive text at the desired scope. bool lzDefineError(| | char cScope, | | // the scope of the new error | | | long lErrorID, | | // the new error code number | | | char* szErrorText | | // the new error description |
Parameters| cScope | | | The scope of the new error. The scope character must be one of these values:
|
Code
|
Constant
|
Meaning |
|
'C'
|
kCosmicScope
|
Available in all contexts |
|
'G'
|
kGlobalScope
|
Available in current context only |
|
| lErrorID | | | The error code number to be established. |
| szErrorText | | | The description of the new error. |
Return Value| | Returns TRUE if the new error is successfully defined. Returns FALSE otherwise. |
Remarks| | Error code values below 10000 are reserved for internal use. Any new error established by this function must have a code greater than or equal to 10000.
Errors defined at cosmic scope are available to all contexts. Errors defined at global scope are available only in the context in which they are defined. |
Versions| | Introduced in Elzed 1.0.0 | | | This page describes the version of lzDefineError active in Elzed 2.5.0 (15: 2.5.0) |
See Also |
| |