IEntity::GetRelationship method (structuredquery.h)

Retrieves the IRelationship object for this entity as requested by name.

Syntax

HRESULT GetRelationship(
  [in]          LPCWSTR       pszRelationName,
  [out, retval] IRelationship **pRelationship
);

Parameters

[in] pszRelationName

Type: LPCWSTR

The name of the relationship to find.

[out, retval] pRelationship

Type: IRelationship**

Receives the address of a pointer to the requested IRelationship object, or NULL if this entity has no relationship with the name specified.

Return value

Type: HRESULT

Returns S_OK if successful, S_FALSE if there is no matching relationship, 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