IsAncestorObjectOf

Description

The IsAncestorObjectOf method determines whether the current PBDOM_CHARACTERDATA is the ancestor of another PBDOM_OBJECT.

Syntax

pbdom_chardata_name.IsAncestorObjectOf(pbdom_object pbdom_object_ret)

Argument

Description

pbdom_chardata_name

The name of a PBDOM_CHARACTERDATA

pbdom_object_ref

A PBDOM_OBJECT to check against


Return value

Boolean.

Returns true if the current PBDOM_CHARACTERDATA is the ancestor of the referenced PBDOM_OBJECT, and false otherwise.

Throws

EXCEPTION_PBDOM_OBJECT_INVALID_FOR_USE -- If this PBDOM_CHARACTERDATA is not a reference to an object derived from PBDOM_CHARACTERDATA.

Usage

Currently, false is always returned because no subclasses of PBDOM_CHARACTERDATA contain child nodes. Therefore, they cannot be ancestors of a PBDOM_OBJECT.