Description
Tests for the equality of the current PBDOM_DOCUMENT object and a referenced PBDOM_OBJECT.
Syntax
pbdom_document_name.Equals(pbdom_object pbdom_object_ref)
Argument |
Description |
---|---|
pbdom_document_name |
The name of a PBDOM_OBJECT |
pbdom_object_ref |
A PBDOM_OBJECT to test for equality with the current PBDOM_OBJECT |
Return value
Boolean.
Returns true if the current PBDOM_DOCUMENT object is equivalent to the input PBDOM_OBJECT, and false otherwise.
Throws
EXCEPTION_PBDOM_OBJECT_INVALID_FOR_USE -- The input PBDOM_OBJECT is not associated with a derived PBDOM_OBJECT class object.
EXCEPTION_INVALID_ARGUMENT -- The input PBDOM_OBJECT is invalid. This can happen if the object has not been initialized properly or is a null object reference.
Usage
True is returned only if the referenced PBDOM_OBJECT is also a PBDOM_DOCUMENT object and refers to the same DOM document as the current PBDOM_DOCUMENT object.