Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method retrieves the code page description that corresponds to uiCodePage.

Syntax 

HRESULT GetCodePageDescription( 
  UINT 
uiCodePage,
  LCID 
lcid,
  LPWSTR 
lpWideCharStr,
  int 
cchWideChar
);

Parameters

uiCodePage

[in] Code page identifier value for which the caller wants the information.

lcid

[in] Local language identifier (LCID) that specifies the user-preferred language.

lpWideCharStr

[in, out] Long pointer to a Unicode character string for which the client is requesting the code page description.

cchWideChar

[in] Value indicating the number of characters in the string pointed to by the lpWideCharStrparameter.

Return Value

The following table shows the possible return values for this method.

Value Description

S_OK

Success.

S_FALSE

The method cannot validate the code page.

E_FAIL

An error occurred.

Requirements

Header mlang.h, mlang.idl
Library mlang.dll
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later