IMultiLanguage::EnumCodePages

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method creates a Code Page Enumeration object, initializes it with the value specified with the grfFlags parameter, and retrieves the corresponding IEnumCodePage interface.

Syntax

HRESULT EnumCodePages( 
  DWORD grfFlags,
  IEnumCodePage** ppEnumCodePage
);

Parameters

• grfFlags
  [in] Flag that specifies the possible uses for a code page. This parameter is used to control code page enumeration. This value must be a combination of the MIMECONTF constant values.

• ppEnumCodePage
  [out] Address of a buffer that receives an IEnumCodePage interface.

Return Value

Returns NOERROR if successful or E_OUTOFMEMORY if the attempt to create the object fails.

Remarks

A client uses this method to gather code page information for all the code pages in the MIME database. Through the IEnumCodePage interface, a client can create an array of MIMECPINFO structures, which contain detailed information about the code pages in the MIME database to which the grfFlags parameter applies.

Although the IEnumCodePage interface is retrieved through this method, the caller is still responsible for releasing it when it is no longer needed.

Requirements