Jump to content

VioGetCp

From EDM2
Revision as of 02:36, 21 December 2016 by Ak120 (talk | contribs) (Ak120 moved page OS2 API:CPI:VioGetCp to VioGetCp)

Queries the code page currently used to display text data.

Syntax

#define INCL_VIO
#include <os2.h>

ULONG      Reserved;    /*  Reserved.  Must be 0. */
PUSHORT    CodePageID;  /*  Code-page ID. */
HVIO       VioHandle;   /*  Presentation-space handle. */
APIRET     rc;          /*  Return code. */

rc = VioGetCp(Reserved, CodePageID, VioHandle);

Parameters

Reserved (ULONG) - input
Reserved. Must be 0.
CodePageID (PUSHORT) - output
Code-page ID.
The address of a word in the application's data area. The current video code page is returned in this word.
VioHandle (HVIO) - input
Presentation-space handle.
This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS.

Return Code

rc (APIRET) - returns

VioGetCp returns one of the following values:

  • 0 NO_ERROR
  • 355 ERROR_VIO_MODE
  • 421 ERROR_VIO_INVALID_PARMS
  • 436 ERROR_VIO_INVALID_HANDLE

Remarks

The display code-page ID, previously set by VioSetCp or inherited from the requesting process, is returned to the caller. The returned code-page tag is the currently active code page.