IMLangConvertCharset::DoConversionFromUnicode Method

Converts the given wide-character string from Unicode to the destination code page of the Conversion Object.

Syntax

HRESULT DoConversionFromUnicode(
    WCHAR *pSrcStr,
    UINT *pcSrcSize,
    CHAR *pDstStr,
    UINT *pcDstSize
);

Parameters

pSrcStr

[in] Address of the Unicode string to be converted.

pcSrcSize

[in, out] Address of the buffer that stores the length of the source string, in character counts. If this is NULL, or if the length specified is -1, the method assumes pSrcStr is null-terminated. When conversion is successful, the method returns the number of characters processed to this buffer.

pDstStr

[in] Address of the string buffer where the conversion result is stored.

pcDstSize

[in, out] Address of the buffer that stores the length, in bytes, of the buffer specified with pDstStr. When conversion is successful, the method returns the number of bytes copied to pDstStr to this buffer.

Return Value

Returns one of the following values:

S_OK	Success.
S_FALSE	The conversion specified is not supported. This happens when the newly detected source code page is not supported on the system.
E_FAIL	An error occurred.

Remarks

Unlike IMLangConvertCharset::DoConversion, this method always converts from Unicode to a multibyte code page.

To properly use this method, the source code page of the Conversion Object must be initialized to Unicode. If the source code page is not Unicode, the method still does the conversion but the result is not guaranteed.

Note that the size of the Unicode string to be converted is given in characters, while the size of the returned multibyte string is given in bytes.

See Also

IMLangConvertCharset, IMLangConvertCharset::DoConversionToUnicode, IMLangConvertCharset::Initialize

Does this content meet your programming needs? Write us!

Back to top