IMultiLanguage::ConvertStringFromUnicode Method

---

Translates the source Unicode string to the specified multibyte code page.

Syntax

HRESULT ConvertStringFromUnicode(
    DWORD *pdwMode,
    DWORD dwEncoding,
    WCHAR *pSrcStr,
    UINT *pcSrcSize,
    CHAR *pDstStr,
    UINT *pcDstSize
); 

Parameters

pdwMode

[in, out] Storage for conversion context. A calling function should only provide storage that is initialized with zero at the first call to the method. The caller should not modify the value.

dwEncoding

[in] Code page identifier value for the destination multibyte string. This value is equivalent to the uiCodePage member of the MIMECPINFO structure assigned to dwEncoding.

pSrcStr

[in] Address of the Unicode string that is 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 -1 is specified as the length, the API 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 will be stored.

pcDstSize

[in, out] Address of the buffer that stores the length of pDstStr, in byte counts. 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 specified conversion is not supported on the system.
E_FAIL	An error occurred.

Remarks

Note that the size of the Unicode string to be converted is specified with a character count, while the size of the multibyte string returned is given in bytes.

Windows CE

Windows CE	Use version 2.12 and later
Minimum availability	Internet Explorer 4.0

See Also

IMultiLanguage2::ConvertStringFromUnicodeEx, IMultiLanguage2::ConvertStringInIStream, IMultiLanguage2::ConvertStringToUnicodeEx