ConvertINetMultiByteToUnicode
A version of this page is also available for
4/8/2010
This function translates a source string to a Unicode string and returns the result to each result buffer.
Syntax
HRESULT ConvertINetMultiByteToUnicode(
LPDWORD lpdwMode,
DWORD dwSrcEncoding,
LPCSTR lpSrcStr,
LPINT lpnMultiCharCount,
LPWSTR lpDstStr,
LPINT lpnWideCharCount
);
Parameters
- lpdwMode
Pointer to a DWORD that is used internally to store conversion context. A caller should provide storage that is initialized with zero at the first call to the function. A caller must not modify the value without calling MLANG service functions.
- dwSrcEncoding
DWORD that contains the code page identifier value for the multibyte source string.
- lpSrcStr
Pointer to the multibyte string that is being converted.
- lpnMultiCharCount
Pointer to the buffer that stores the length of the source string in bytes. If this is NULL, or if the length specified is -1, the function assumes that the source string is null-terminated. When conversion is successful, the function returns to this buffer the number of bytes processed.
- lpDstStr
Pointer to the string buffer where the conversion result is stored.
- lpnWideCharCount
Pointer to the buffer that stores the length of the destination buffer as a character count. When the conversion is successful, the function returns the number of characters copied to the lpDstStr buffer.
Return Value
The following table shows the values returned by this function.
Value | Description |
---|---|
S_OK |
Performed the conversion successfully. |
S_FALSE |
The specified conversion is not supported on the system. |
E_FAIL |
An error has occurred. |
Remarks
An application typically calls this function to convert a character stream in an Internet character set to a Microsoft Windows code page, or to convert a Windows code page to a character stream in an Internet character set. This conversion can also be performed by calling the IMultiLanguage::ConvertStringToUnicode method. Note that the size of the multibyte string to be converted is specified in bytes, while the size of the Unicode string returned is given in characters.
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 |