GetECX - Retrieves the effective Cockpit Application Character Set

Top  Previous  Next

Syntax

 

<nECX> := GetECX()

 

Parameters

 

none

 

Return value

 

The return value is the current effective Cockpit application character set.

 

Description

 

The Cockpit application character set controls the text string character set conversions executed during all string transfer functions. The character set conversion performed depends on the effective Cockpit application character set which can be retrieved by the function GetECX. The effective Cockpit application character set can be a fixed value, if CX_ANSI or CX_OEM were passed in to a prior call to SetCX. It can also be controlled by the current character set selection of the runtime environment, which is the default.

 

The returned value is either CX_ANSI or CX_OEM.

 

Classification

 

Core

 

Category

 

Character Set Conversion Functions

 

Quick Info

 

Library: cckptcor.lib / cckptcor.dll

Header: CharacterSet.ch

 

See also

 

SetCX, ConvTextIn, ConvTextOut, ConvWTextIn, ConvWTextOut

 

Example

 

 

* Get the effective Cockpit application character set

setting := GetECX()