IMultiLanguage2::ConvertStringInIStream method

Converts the given stream from the source code page to the destination code page.

Syntax

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

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.

  • dwFlag [in]
    One of the MLCONVCHAR-defined bit flag values. A caller can specify the MLCONVCHARF_USEDEFCHAR constant, which indicates that when the API encounters an unconvertible character in the source stream, the sequence of characters in lpFallBack is used in its place.

  • lpFallBack [in]
    A null-terminated sequence of Unicode characters that are output instead of an unconvertible Unicode character when the dwFlag parameter is set to MLCONVCHARF_USEDEFCHAR.

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

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

  • pstmIn [in]
    A pointer to the IStream interface for the source stream.

  • pstmOut [in]
    A pointer to the IStream interface where the converted result is stored.

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 occurred.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Mlang.h

IDL

Mlang.idl

DLL

Mlang.dll

See also

IMultiLanguage2

Reference

ConvertStringFromUnicodeEx

ConvertStringToUnicodeEx