IMultiLanguage2::CreateConvertCharset method

  • Article

Creates a charset Conversion object and retrieves its corresponding IMLangConvertCharset interface.

Syntax

HRESULT CreateConvertCharset(
  [in]  UINT                 uiSrcCodePage,
  [in]  UINT                 uiDstCodePage,
  [in]  DWORD                dwProperty,
  [out] IMLangConvertCharset **ppMLangConvertCharset
);

Parameters

  • uiSrcCodePage [in]
    Code page identifier value for the source character stream to which the caller wants the Conversion object dedicated.

  • uiDstCodePage [in]
    Code page identifier value for the destination character stream to which the caller wants the Conversion object dedicated.

  • dwProperty [in]
    One of the MLCONVCHAR-defined values. This flag indicates how to display unconvertible Unicode characters when performing Unicode-to-multibyte conversion.

  • ppMLangConvertCharset [out]
    Address of a pointer to the buffer where the client will receive an IMLangConvertCharset interface.

Return value

Returns one of the following values:

Return code Description
S_OK

Success.
S_FALSE

The object was created but could not be initialized because the specified set of source/destination code pages is not supported.
E_FAIL

The method failed to create an instance of the object.

 

Remarks

A client should use the Conversion object to perform many repeated character set conversions with the same combination of source/destination code pages.

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

Requirements

Minimum supported client

 Windows XP

Minimum supported server

 Windows 2000 Server

Header

 Mlang.h

IDL

 Mlang.idl

DLL

 Mlang.dll

See also

IMultiLanguage2