IQueryParser::RestatePropertyValueToString method (structuredquery.h)

Article
02/22/2024

Restates a specified property for a condition as a query string.

Syntax

HRESULT RestatePropertyValueToString(
  [in]  ICondition *pCondition,
  [in]  BOOL       fUseEnglish,
  [out] LPWSTR     *ppszPropertyName,
  [out] LPWSTR     *ppszQueryString
);

Parameters

[in] pCondition

Type: ICondition*

A condition to be restated as a query string.

[in] fUseEnglish

Type: BOOL

Reserved. Must be FALSE.

[out] ppszPropertyName

Type: LPWSTR*

Receives a pointer to the property name as a Unicode string. The calling application must free the string by calling CoTaskMemFree.

[out] ppszQueryString

Type: LPWSTR*

Receives a pointer to a query string for that property. The calling application must free the string by calling CoTaskMemFree.

Return value

Type: HRESULT

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

Remarks

If the leaf nodes of the condition contain more than one property name, or no property name at all, E_INVALIDARG is returned.

Requirements

Requirement	Value
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
Redistributable	Windows Desktop Search (WDS) 3.0

Share via