cwbNL_GetLangName

Purpose

Return the descriptive name of a language setting.

Syntax

 
unsigned int CWB_ENTRY cwbNL_GetLangName(
                             char           *lang,
                             char           *resultPtr,
                             unsigned short  resultLen,
                             unsigned short *requiredLen,
                             cwbSV_ErrHandle errorHandle);

Parameters

char * lang - input

Address of the ASCIIZ string representing the language.

char * resultPtr - output

Pointer to the buffer to contain the result.

unsigned short resultLen - input

Length of the result buffer. Recommended size is CWBNL_MAX_NAME_SIZE.

unsigned short * requiredLen - output

Actual length of the result. If requiredLen > resultLen, the return value will be CWB_BUFFER_OVERFLOW.

cwbSV_ErrHandle errorHandle - input

Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle() API. The messages may be retrieved through the cwbSV_GetErrText() API. If the parameter is set to zero, no messages will be retrievable.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_HANDLE

Invalid handle.

CWB_INVALID_POINTER

NULL passed on output parameter.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_BUFFER_OVERFLOW

Output buffer too small, data truncated.

Usage

The language must be a value returned from one of the following APIs:

• cwbNL_GetLang
• cwbNL_FindFirstLang
• cwbNL_FindNextLang