Equals

Description

Tests for the equality of a referenced PBDOM_OBJECT.

Syntax

pbdom_object_name.Equals(pbdom_object pbdom_object_ref)

Argument

Description

pbdom_object_name

The name of the PBDOM_OBJECT

pbdom_object_ref

The PBDOM_OBJECT to test for equality with the current PBDOM_OBJECT


Return value

Boolean.

Returns true if the current PBDOM_OBJECT is equivalent to the input PBDOM_OBJECT, and false otherwise.

Throws

EXCEPTION_PBDOM_OBJECT_INVALID_FOR_USE -- This PBDOM_OBJECT object or 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.