IMultiLanguage::ConvertString

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method converts the given source string from the source code page to the destination code page.

Syntax

HRESULT ConvertString( 
  DWORD* pdwMode,
  DWORD dwSrcEncoding,
  DWORD dwDstEncoding,
  BYTE* pSrcStr,
  UINT* pcSrcSize,
  BYTE* pDstStr,
  UINT* pcDstSize
);

Parameters

• pdwMode
  [in, out] Storage for conversion context. The 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.

• dwSrcEncoding
  [in] Specifies the code page identifier value for the source string. This value is equivalent to the uiCodePage member of the MIMECPINFO structure assigned to dwSrcEncoding.

• dwDstEncoding
  [in] Specifies the code page identifier value for the destination string. This value is equivalent to the uiCodePage member of the MIMECPINFO structure assigned to dwDstEncoding.

• pSrcStr
  [in] Address of the string that is being converted.

• pcSrcSize
  [in, out] Pointer to the buffer that stores the length of the source string, in bytes. 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] Pointer to the string buffer where the conversion result is stored.

• pcDstSize
  [in, out] Pointer to the buffer that stores the length of the string pointed to by the pDstStr parameter, in bytes. When the conversion is successful, the method returns to this buffer the number of bytes copied to the string.

Return Value

The following table shows the possible return values for this method.

Remarks

This method takes a pointer to a BYTE array for both the source and destination string buffers. The size of this buffer is handled as the number of bytes for both the inbound and outbound parameters.

Requirements