Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method translates the source string from the specified code page to Unicode.

Syntax 

HRESULT ConvertStringToUnicode( 
  DWORD* 
pdwMode,
  DWORD 
dwEncoding,
  CHAR* 
pSrcStr,
  UINT* 
pcSrcSize,
  WCHAR* 
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 source multibyte string. This value is equivalent to the uiCodePagemember of the MIMECPINFOstructure assigned to the dwEncodingparameter.

pSrcStr

[in] Address of the multibyte string that is to be converted.

pcSrcSize

[in, out] Address of the buffer that stores the length of the source string, in byte counts. If this value is NULL, or if the length specified is -1, the method assumes that the string pointed to by the pSrcStrparameter is null-terminated. When the conversion is successful, the method returns the number of bytes 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 memory allocated for the string pointed to by the pDstStrparameter, in character counts. When the conversion is successful, the method returns to this buffer the number of characters 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 conversion specified is not supported on the system.

E_FAIL

An error occurred.

Remarks

The size of the multibyte string to be converted is specified with a byte count, 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