IEntity::DefaultPhrase Method

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

Syntax

HRESULT DefaultPhrase(      
    LPWSTR *ppszPhrase
);

Parameters

  • ppszPhrase
    [out, retval]  Returns the default phrase as a Unicode string. The calling application must free the returned string using CoTaskMemFree.

Return Value

Returns S_OK if successful, or an error value otherwise.