Usina BRAdvPL Guide
Sign in
← All topics
INCLUDEUnder review

Error.ch

#Include "Error.ch"

Defines severity and numeric categories used by error objects and routines.

IncludesError handlingHistorical referenceCompilation
01 · OVERVIEW

Overview

Defines severity and numeric categories used by error objects and routines. Symbols highlighted by the historical file include: ES_WARNING; ES_ERROR; ES_CATASTROPHIC; EG_ARG; EG_BOUND; EG_ZERODIV; EG_SYNTAX. Confirm names, availability and behavior against the official include package for the target environment.

02 · SYNTAX

Syntax

#Include "Error.ch"

Parameters

Error.ch
.ch fileOptional

Compile-time include; whether it is required depends on the symbols used by the source.

Return value

An include has no runtime return value. Its directives are processed during compilation.

03 · PRACTICAL EXAMPLE

Minimal include for study

#Include "Error.ch"

User Function ExError()
    // Use only symbols documented for the target release.
Return
Expected result

The preprocessor makes definitions from the configured include path available.

BEST PRACTICES
  • Include it only when the source depends on one of its symbols.
  • Use includes matching the environment and LIB version.
  • Search the current package before treating a historical symbol as valid.
  • Prefer current official documentation for supported APIs.
COMMON PITFALLS
  • The analyzed file is historical.
  • Copying an old include can create LIB or RPO incompatibilities.
  • A declared directive does not prove that its related API is still supported.

Related content

REFERENCES
  1. MICROSIGA SOFTWARE S.A. include_001.zip. Historical package supplied to the project on Aug. 8, 2026.
Status
Under review
Page created on
Last reviewed on
Original language
Portuguese
Reviewed by
Usina.BR