This is part of Family API which allow to create dual-os version of program runs under OS/2 and DOS

Note: This is legacy API call. It is recommended to use 32-bit equivalent

DosGetCp

This call allows a process to query the current process code page and the prepared system code pages.

Syntax

DosGetCp (Length, CodePageList, DataLength)

Parameters

Length (USHORT) - input : Length, in bytes, of CodePageList. This length should be at least 2 bytes. If the length is less than the bytes needed to return all the prepared system code pages than the returned CodePageList is truncated.

CodePageList (PUSHORT) - output : Address of the list of available system code pages. The format of the information returned in this list is:

1 - Current code page identifier

2 - The first prepared code page

3 - The second prepared code page

N - Other prepared system code pages.

DataLength (PUSHORT) - output : Address of the length, in bytes, of the returned data.

Return Code

rc (USHORT) - return:Return code

0 NO_ERROR

473 ERROR_CPLIST_TOO_SMALL

Remarks

If the process code page identifier was previously set by DosSetCp or inherited by a process, it is returned to the caller.

An input list size (length) of two bytes returns only the current process code page identifier. If CodePageList length is too small to hold all the available information, then as much information as possible is provided in the available space and ERROR_CPLIST_TOO_SMALL is returned.

If no codepages were prepared with the CODEPAGE command, a length of two and current codepage identifier value of zero is returned.

Family API Considerations

Some options operate differently in the DOS mode than in OS/2 mode. Therefore, the following restriction applies to DosGetCp when coding for the DOS mode:

The current process code page, and no more than one prepared system code page, is returned.

Bindings

C

#define INCL_DOSNLS USHORT rc = DosGetCp(Length, CodePageList, DataLength); USHORT Length; /* Length of list */ PUSHORT CodePageList; /* List (returned) */ PUSHORT DataLength; /* Length of list (returned) */ USHORT rc; /* return code */

MASM

EXTRN DosGetCp:FAR INCL_DOSNLS EQU 1 PUSH WORD Length ;Length of list PUSH@ WORD CodePageList ;List (returned) PUSH@ WORD DataLength ;Length of list (returned) CALL DosGetCp Returns WORD

Example

This example gets the current code page and then up to 3 other prepared codepages.

#define INCL_DOSNLS USHORT CpList[8]; USHORT CpSize; USHORT rc; rc = DosGetCp(sizeof(CpList), /* Length of list */ CpList, /* List */ &CpSize); /* Length of returned list */

Related Functions

*DosSetCp

Family API
DOS	Process Manager	DosBeep DosExit DosSleep DosExecPgm
File Manager	DosChDir DosChgFilePtr DosClose DosDelete DosDupHandle DosMkDir DosMove DosQCurDir DosQCurDisk DosSetFileMode DosOpen DosQFileInfo DosRead DosQFileMode DosQFSInfo DosQVerify DosRmDir DosSelectDisk DosFindClose DosFindFirst DosFindNext DosSetFileInfo DosSetVerify DosWrite DosFileLocks DosSetFHandState DosNewSize DosBufReset DosQFHandState DosSetFSinfo DosShutdown
Memory Manager	DosFreeSeg DosSubAlloc DosSubFree DosSubSet DosAllocHuge DosAllocSeg DosReallocHuge DosReallocSeg DosGetHugeShift DosCreateCSAlias
NLS	DosCaseMap DosGetCtryInfo DosGetDBCSEv DosSetCtryCode DosGetCollate DosGetMessage DosInsMessage DosPutMessage
Date and Time	DosSetDateTime DosGetDateTime
Devices	DosDevConfig DosDevIOCtl DosDevIOCtl2
Signals	DosHoldSignal DosSetSigHandler
Misc	BadDynLink DosGetEnv DosGetMachineMode DosGetVersion DosError DosErrClass DosSetVec
KBD	KbdCharIn KbdFlushBuffer KbdGetStatus KbdSetStatus KbdStringIn KbdPeek
VIO	VioGetBuf VioGetConfig VioGetCurPos VioGetCurType VioGetPhysBuf VioReadCellStr VioReadCharStr VioScrollUp VioScrollDn VioScrollLf VioScrollRt VioScrUnLock VioSetCurPos VioSetCurType VioSetMode VioGetMode VioShowBuf VioWrtCellStr VioWrtCharStr VioWrtCharStrAtt VioWrtNAttr VioWrtNCell VioWrtNChar VioWrtTTY VioScrLock VioPopUp
Tools	BIND
Modules	DOSCALLS.DLL VIOCALLS.DLL KBDCALLS.DLL MSG.DLL
Libraries	API.LIB OS2386.LIB FAPI.LIB DOSCALLS.LIB SUBCALLS.LIB