IMultiLanguage2::ConvertStringInIStream 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] 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] One of the MLCONVCHAR-defined bit flag values. A caller can specify the MLCONVCHAR_USEDEFCHAR constant, which indicates that when the API encounters an unconvertible character in the source stream, the sequence of characters in lpFallBack 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] 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] 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] Address of the IStream interface for the source stream.

pstmOut

[in] Address of the IStream interface where the converted result will be stored.

Return Value

Returns one of the following values:

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

See Also

IMultiLanguage2::ConvertStringFromUnicodeEx, IMultiLanguage2::ConvertStringToUnicodeEx