Usina BRAdvPL Guide
Sign in
← All topics
INCLUDEUnder review

WinAPI.ch

#Include "WinAPI.ch"

Collects Windows API constants for windows, messages, buttons and styles. It is platform-dependent and requires caution.

IncludesLegacy WindowsHistorical referenceCompilation
01 · OVERVIEW

Overview

Collects Windows API constants for windows, messages, buttons and styles. It is platform-dependent and requires caution. Symbols highlighted by the historical file include: IDOK; IDCANCEL; BN_CLICKED; CS_*; WS_*. Confirm names, availability and behavior against the official include package for the target environment.

02 · SYNTAX

Syntax

#Include "WinAPI.ch"

Parameters

WinAPI.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 "WinAPI.ch"

User Function ExWinapi()
    // 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