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 detects the code page of the given stream.

Syntax 

HRESULT DetectCodepageInIStream( 
  DWORD 
dwFlag,
  DWORD 
dwPrefWinCodePage,
  IStream* 
pstmIn,
  DetectEncodingInfo* 
lpEncoding,
  INT* 
pnScores
);

Parameters

dwFlag

[in] Specifies one of the MLDETECTCP-defined bit flag values that specify the type of incoming source text. Setting the bit flags helps the detection engines produce more accurate results.

dwPrefWinCodePage

[in] Specifies the preferred Windows code page. If this value is set to zero, this method returns all possible encodings. Otherwise, it lists only those encodings related to this parameter.

pstmIn

[in] Pointer to the IStreaminterface for the source stream.

lpEncoding

[in, out] Pointer to an array of DetectEncodingInfostructures where the detection information will be returned.

pnScores

[in, out] Pointer to a buffer that contains the number of DetectEncodingInfostructures allocated in the array pointed to by the lpEncodingparameter. When this method is successful, this parameter returns the number of elements of the array that have been filled in.

Return Value

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

Value Description

S_OK

Success.

S_FALSE

The method cannot determine the code page of the input stream.

E_FAIL

An error occurred.

Remarks

The caller is responsible for allocating and freeing the lpEncodingarray.

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