IMultiLanguage2::ConvertStringToUnicodeEx method

Article
11/05/2015

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

Syntax

HRESULT ConvertStringToUnicodeEx(
  [in, out] DWORD     *pdwMode,
  [in]      DWORD     dwEncoding,
  [in]      __wchar_t *pSrcStr,
  [in, out] UINT      *pcSrcSize,
  [in]      WCHAR     *pDstStr,
  [in, out] UINT      *pcDstSize,
  [in]      DWORD     dwFlag,
  [in]      WCHAR     *lpFallBack
);

Parameters

pdwMode [in, out]
The storage for conversion context. A calling function should provide only storage that is initialized with zero at the first call to the method. The caller should not modify this value.
dwEncoding [in]
The code page identifier value for the source multibyte string. This value is equivalent to the uiCodePage member of the MIMECPINFO structure assigned to dwEncoding.
pSrcStr [in]
A pointer to the multibyte string to be converted.
pcSrcSize [in, out]
A pointer to the buffer that stores the length of the source string, in byte counts. If this is NULL, or if the length specified is -1, the API assumes pSrcStr is null-terminated. When conversion is successful, the function returns the number of bytes processed to this buffer.
pDstStr [in]
A pointer to the string buffer where the conversion result is stored.
pcDstSize [in, out]
A pointer to the buffer that stores the memory allocated for pDstStr, in character counts. When conversion is successful, the function returns the number of characters copied to pDstStr to this buffer.
dwFlag [in]
This parameter is currently ignored. It is recommended, however, that a caller set it to zero, in case this changes.
lpFallBack [in]
This parameter is currently ignored. It is recommended, however, that a caller set it to NULL, in case this changes.

Return value

Returns one of the following values.

Return code	Description
S_OK	Success.
S_FALSE	The conversion specified is not supported on the system.
E_FAIL	An error has occurred.

Remarks

Note that 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

Minimum supported client	Windows XP
Minimum supported server	Windows 2000 Server
Header	Mlang.h
IDL	Mlang.idl
DLL	Mlang.dll

Share via