IMultiLanguage2::DetectInputCodepage

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method detects the code page of the given string.

Syntax

HRESULT DetectInputCodepage( 
  DWORD dwFlag,
  DWORD dwPrefWinCodePage,
  CHAR* pSrcStr,
  INT* pcSrcSize,
  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.
  • pSrcStr
    [in] Source string for which the client wants to detect the code page.
  • pcSrcSize
    [in, out] Address of the buffer that stores the size of the string pointed to by the pSrcStr parameter, in bytes. When this method is successful, it returns the number of bytes processed to this buffer.
  • lpEncoding
    [in, out] Pointer to an array of DetectEncodingInfo structures where the detection information will be returned.
  • pnScores
    [in, out] Pointer to a buffer that contains the number of DetectEncodingInfo structures allocated in the array pointed to by the lpEncoding parameter. 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 lpEncoding array.

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