GetCodePageDisplayStr

The SNA National Language Support (SNANLS) GetCodePageDisplayStr function copies the SNANLS code page display name identified by a key to a character string passed as a parameter.

Syntax

  
BOOL WINAPI GetCodePageDisplayStr(   
Int nKey  
WCHAR *szDisplayStr  
Int IDisplayStr  
);  

Parameters

nKey
Supplied parameter. The numeric key to a code page. This value is an opaque index into an array containing the code pages supported by SNANLS. This value is normally the CodePageKey member of a CodePage structure returned from a previous call to FindFirstCodePage or FindNextCodePage.

szDisplayStr
Supplied and returned parameter. A pointer to a wide-character array where the SNANLS display name for the specific code page should be copied.

On a successful return, the memory location pointed to by this parameter will be filled with the SNANLS display name for the specific code page. The character string is null terminated.

On failure, no changes will be made to the memory pointed to by this parameter.

IDisplayStr
Represents the number of available characters in the szDisplaystr parameter.

Return Value

The GetCodePageDisplayStr function returns a value of TRUE on success. On failure, the returned value is FALSE.

Remarks

This function is supported by SNANLS on Host Integration Server.