IMultiLanguage::ConvertStringToUnicode

A version of this page is also available for

Windows Embedded CE 6.0 R3

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 uiCodePage member of the MIMECPINFO structure assigned to the dwEncoding parameter.

• 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 pSrcStr parameter 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 pDstStr parameter, 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.

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