Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Retrieves an entity by name from the loaded schema.
Syntax
HRESULT GetEntity(
[in] LPCWSTR pszEntityName,
[out, retval] IEntity **pEntity
);
Parameters
[in] pszEntityName
Type: LPCWSTR
The name of the entity being requested.
[out, retval] pEntity
Type: IEntity**
Receives the address of a pointer to the requested entity. The calling application must release the entity by calling its IUnknown::Release method. If there is no entity with the specified name, this parameter is set to NULL.
Return value
Type: HRESULT
Returns S_OK if successful, S_FALSE if there is no entity with the specified name, or an error value otherwise.
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 |