Share via


IMultiLanguage2::ConvertStringInIStream

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

HRESULT ConvertStringInIStream( 
  DWORD* pdwMode,
  DWORD dwFlag,
  WCHAR* lpFallBack,
  DWORD dwSrcEncoding,
  DWORD dwDstEncoding,
  IStream* pstmIn,
  IStream* pstmOut
);

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.
  • dwFlag
    [in] Specifies one of the MLCONVCHAR-defined bit flag values. A caller can specify the MLCONVCHAR_USEDEFCHAR constant, which indicates that when the method encounters an unconvertible character in the source stream, the sequence of characters in the lpFallBack parameter 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 dwFlag parameter is set to MLCONVCHAR_USEDEFCHAR.
  • dwSrcEncoding
    [in] Specifies the code page identifier value for the source stream. This value is equivalent to the uiCodePage member of the MIMECPINFO structure assigned to the dwSrcEncoding parameter.
  • dwDstEncoding
    [in] Specifies the code page identifier value for the destination stream. This value is equivalent to the uiCodePage member of the MIMECPINFO structure assigned to the dwDstEncoding parameter.
  • pstmIn
    [in] Pointer to the IStream interface for the source stream.
  • pstmOut
    [in] Pointer to the IStream interface where the converted result will be stored.

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.

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