IMultiLanguage::ConvertStringFromUnicode
A version of this page is also available for
4/8/2010
This 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] Specifies the code page identifier value for the destination multibyte string. This value is equivalent to the uiCodePage member of the MIMECPINFO structure assigned to the dwEncoding parameter.
- 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 method assumes that the string pointed to by the pSrcStr parameter is null-terminated. When the 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 the string pointed to by the pDstStr parameter, in byte counts. When the conversion is successful, the method returns to this buffer the number of bytes copied to the string.
Return Value
The following table shows the possible return values for this method.
| Value | Description |
|---|---|
S_OK |
Success. |
S_FALSE |
The specified conversion is not supported on the system. |
E_FAIL |
An error occurred. |
Remarks
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.
Requirements
| Header | mlang.h, mlang.idl |
| Library | mlang.dll |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |