RemoveContent

Description

Removes a child PBDOM_OBJECT from the current PBDOM_DOCUMENT object.

Syntax

pbdom_document_name.RemoveContent(pbdom_object pbdom_object_ref)

Argument

Description

pbdom_document_name

The name of a PBDOM_DOCUMENT object

pbdom_object_ref

The PBDOM_OBJECT to remove


Return value

Boolean.

Returns true if the content was removed, and false otherwise.

Throws

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

EXCEPTION_USE_OF_UNNAMED_PBDOM_OBJECT -- The input PBDOM_OBJECT is nameable, but it has not been assigned a name.

EXCEPTION_PBDOM_OBJECT_INVALID_FOR_USE -- The input PBDOM_OBJECT is not associated with a derived PBDOM_OBJECT class object.

EXCEPTION_WRONG_DOCUMENT_ERROR -- The input PBDOM_OBJECT is not contained within the current PBDOM_DOCUMENT object.

EXCEPTION_WRONG_PARENT_ERROR -- The input PBDOM_OBJECT is not a child of the current PBDOM_DOCUMENT object.

Usage

When a PBDOM_OBJECT is removed from the current PBDOM_DOCUMENT object, all children under the removed PBDOM_OBJECT are also removed.

See also

AddContent

GetContent

InsertContent

SetContent