IConditionGenerator::DefaultPhrase method

This method attempts to produce a phrase that, when recognized by this instance of IConditionGenerator, represents the type and value pair for an entity, relationship, or named entity.

Syntax

HRESULT DefaultPhrase(
  LPCWSTR           pszValueType,
  const PROPVARIANT *ppropvar,
  BOOL              fUseEnglish,
  LPWSTR            *ppszPhrase
);

Parameters

pszValueType

Type: LPCWSTR

The semantic type of the value in ppropvar.

ppropvar

Type: PROPVARIANT const*

The value to be processed.

fUseEnglish

Type: BOOL

The parameter fUseEnglish is reserved: it should be ignored by implementors, and callers should pass FALSE.

ppszPhrase

Type: LPWSTR*

Receives a pointer to the phrase representing the value. If no phrase can be produced, this parameter is set to NULL and the method returns S_FALSE.

Return value

Type: HRESULT

Returns S_OK if successful, S_FALSE if the input arguments are valid but no phrase can be produced, and an error value otherwise.

Requirements

   
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 with SP1 [desktop apps only]
Target Platform Windows
Header structuredquery.h

See also

CONDITION_CREATION_OPTIONS

CONDITION_OPERATION

CONDITION_TYPE

ICondition

ICondition2

IConditionFactory

IConditionGenerator

Reference