Export (0) Print
Expand All

IConditionGenerator::RecognizeNamedEntities method

Identifies named entities in an input string, and creates a collection containing them. The value of each named entity is expressed as a string, which is then used by IConditionGenerator::GenerateForLeaf. The string can contain any data and be in any format, because it is not examined by any other components.

Syntax


HRESULT RecognizeNamedEntities(
  [in]       LPCWSTR pszInputString,
  [in]       LCID lcidUserLocale,
  [in]       ITokenCollection *pTokenCollection,
  [in, out]  INamedEntityCollector *pNamedEntities
);

Parameters

pszInputString [in]

Type: LPCWSTR

The input string to be parsed.

lcidUserLocale [in]

Type: LCID

The LCID against which named entities should be recognized.

pTokenCollection [in]

Type: ITokenCollection*

A pointer to an ITokenCollection object that indicates how the input string was tokenized.

pNamedEntities [in, out]

Type: INamedEntityCollector*

On input, contains an INamedEntityCollector or NULL. On return, contains an INamedEntityCollector collection of the named entities.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Given an input string, a user locale (typically the user's default locale) and a tokenization of the input string, the IConditionGenerator::RecognizeNamedEntities method should be able to identify any named entities in that input string, and then add each entity to the named entity collection.

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Header

Structuredquery.h

IDL

Structuredquery.idl

See also

Reference
IConditionGenerator
IConditionFactory
CONDITION_TYPE
CONDITION_OPERATION
CONDITION_CREATION_OPTIONS
ICondition
ICondition2

 

 

Community Additions

ADD
Show:
© 2014 Microsoft