IsAncestorObjectOf

Description

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

Syntax

pbdom_document_name.IsAncestorObjectOf(pbdom_object pbdom_object_ret)

Argument

Description

pbdom_document_name

The name of a PBDOM_DOCUMENT object

pbdom_object_ref

The PBDOM_OBJECT to check against


Return value

Boolean.

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

Throws

EXCEPTION_INVALID_ARGUMENT -- The input PBDOM_OBJECT is invalid. This can happen if it has not been initialized properly or is a null object reference.