INamedEntity::DefaultPhrase method (structuredquery.h)

Retrieves a default phrase to use for this named entity in restatements.

Syntax

HRESULT DefaultPhrase(
  [out, retval] LPWSTR *ppszPhrase
);

Parameters

[out, retval] ppszPhrase

Type: LPWSTR*

Receives a pointer to the default phrase as a Unicode string. The calling application must free the returned string by calling CoTaskMemFree.

Return value

Type: HRESULT

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

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