IConditionGenerator::DefaultPhrase Method

  • Article

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,
    PROPVARIANT *const,
    BOOL fUseEnglish,
    LPWSTR *ppszPhrase
);

Parameters

  • pszValueType
    [in] The semantic type of the value in ppropvar.
  • const
    [in] The value to be processed.
  • fUseEnglish
    [in]  The parameter fUseEnglish is reserved: it should be ignored by implementors, and callers should pass FALSE.
  • ppszPhrase
    [out, retval] 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

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

See Also

IConditionGenerator, IConditionFactory, CONDITION_TYPE, CONDITION_OPERATION, CONDITION_CREATION_OPTIONS, ICondition, ICondition2