IMLangConvertCharset::DoConversionToUnicode Method

Converts the given string from the source multibyte code page of the Conversion Object to the Unicode character set.

Syntax

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

Parameters

pSrcStr

[in] Address of the string to be converted.

pcSrcSize

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

pDstStr

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

pcDstSize

[in, out] Address of the buffer that stores the length, in characters, allocated for pDstStr. When conversion is successful, the method returns the number of characters 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 performs multibyte-to-Unicode conversion.

To use this method correctly, the conversion object's destination code page must be set to Unicode. If the destination code page is not Unicode, the method converts between the source and destination code pages of the conversion object, and the size returned in pcDstSize will not be correct.

It is important to note that the size of the multibyte string is given in bytes, while the size of the Unicode string returned is the number of Unicode characters.

See Also

IMLangConvertCharset, IMLangConvertCharset::DoConversionFromUnicode, IMLangConvertCharset::Initialize

Does this content meet your programming needs? Write us!

Back to top