IEntity::Base method (structuredquery.h)

Retrieves the parent entity of this entity.

Syntax

HRESULT Base(
  [out, retval] IEntity **pBaseEntity
);

Parameters

[out, retval] pBaseEntity

Type: IEntity**

Receives a pointer to the parent IEntity object, or NULL if there is no parent entity.

Return value

Type: HRESULT

Returns one of the following, or an error value otherwise.

Return code	Description
S_OK	pBaseEntity successfully set.
S_FALSE	The entity has no parent; pBaseEntity successfully set to NULL.

Remarks

Each entity derives from some other entity, except the entity named Entity, for which this method returns S_FALSE. The derived entity inherits all relationships from the base entity.

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