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 Unicode string to the specified multibyte code page.

Syntax 

HRESULT ConvertStringFromUnicodeEx( 
  DWORD* 
pdwMode,
  DWORD 
dwEncoding,
  WCHAR* 
pSrcStr,
  UINT* 
pcSrcSize,
  CHAR* 
pDstStr,
  UINT* 
pcDstSize,
  DWORD 
dwFlag,
  WCHAR* 
lpFallBack
);

Parameters

pdwMode

[in, out] Address of 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 this value.

dwEncoding

[in] Specifies the code page identifier value for the destination multibyte string. This value is equivalent to the uiCodePagemember of the MIMECPINFOstructure assigned to the dwEncodingparameter.

pSrcStr

[in] Pointer to the Unicode string that is to be converted.

pcSrcSize

[in, out] Pointer to 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 pSrcStrparameter is null-terminated. When the conversion is successful, the function returns the number of characters processed to this buffer.

pDstStr

[in] Pointer to the string buffer where the conversion result will be stored.

pcDstSize

[in, out] Pointer to the buffer that stores the length of the string pointed to by the pDstStrparameter, in byte counts. When the conversion is successful, the function returns to the buffer the number of bytes copied to the string.

dwFlag

[in] Specifies one of the MLCONVCHAR-defined bit flag values. A caller can specify the MLCONVCHARF_USEDEFCHAR constant, which indicates that when the method encounters an unconvertible character in the string pointed to by the pSrcStrparameter, the sequence of characters in the lpFallBackparameter is to be used in its place.

lpFallBack

[in] Null-terminated sequence of Unicode characters that are output in place of an unconvertible Unicode character when the dwFlagparameter is set to MLCONVCHARF_USEDEFCHAR.

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 has 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