RemoveChildElements

Description

The RemoveChildElements method is overloaded:

  • Syntax 1 method removes from the current PBDOM_ELEMENT object all child PBDOM_ELEMENT objects. It uses no parameters.

  • Syntax 2 method removes from the current PBDOM_ELEMENT object all child PBDOM_ELEMENT objects that have the specified local name and belong to no namespace.

  • Syntax 3 removes from the current PBDOM_ELEMENT object all child PBDOM_ELEMENT objects (one level deep) that have the specified local name and belong to the specified namespace.

Syntax

For this syntax

See

RemoveChildElements()

RemoveChildElements Syntax 1

RemoveChildElements(string strElementName)

RemoveChildElements Syntax 2

RemoveChildElements(string strElementName, string strNamespacePrefix, string strNamespaceUri)

RemoveChildElements Syntax 3


RemoveChildElements Syntax 1

Description

Removes from the current PBDOM_ELEMENT object all child PBDOM_ELEMENT objects. It uses no parameters.

Syntax

pbdom_element_name.RemoveChildElements()

Argument

Description

pbdom_element_name

The name of a PBDOM_ELEMENT object


Return value

Boolean.

Returns true if any child PBDOM_ELEMENT object was removed and false otherwise.

See also

GetChildElement

GetChildElements

HasChildElements

HasChildren

IsRootElement

RemoveChildElement

RemoveChildElements Syntax 2

RemoveChildElements Syntax 3

RemoveChildElements Syntax 2

Description

Removes from the current PBDOM_ELEMENT object all child PBDOM_ELEMENT objects that have the specified local name and belong to no namespace.

Syntax

pbdom_element_name.RemoveChildElements(string strElementName)

Argument

Description

pbdom_element_name

The name of a PBDOM_ELEMENT object

strElementName

The name of the child PBDOM_ELEMENT objects to remove


Return value

Boolean.

Returns true if any child PBDOM_ELEMENT object was removed, and false otherwise.

See also

GetChildElement

GetChildElements

HasChildElements

HasChildren

IsRootElement

RemoveChildElement

RemoveChildElements Syntax 1

RemoveChildElements Syntax 3

RemoveChildElements Syntax 3

Description

Removes from the current PBDOM_ELEMENT object all child PBDOM_ELEMENT objects (one level deep) that have the specified local name and belong to the specified namespace.

Syntax

pbdom_element_name.RemoveChildElements(string strElementName, string strNamespacePrefix, string strNamespaceUri)

Argument

Description

pbdom_element_name

The name of a PBDOM_ELEMENT object

strElementName

The name of the child PBDOM_ELEMENT objects to remove

strNamespacePrefix

Prefix of the namespace of the child PBDOM_ELEMENT objects to remove

strNamespaceUri

URI of the namespace of the child PBDOM_ATTRIBUTE objects to remove


Return value

Boolean.

Returns true if any child PBDOM_ELEMENT object was removed and false otherwise.

Throws

EXCEPTION_INVALID_ARGUMENT -- If any of the input parameters is invalid, for example, null.

EXCEPTION_INVALID_NAME -- If the input element name or namespace prefix or URI is invalid. The only exception is if the input element name is an empty string, in which case all element names match.

EXCEPTION_MEMORY_ALLOCATION_FAILURE -- If there was any memory allocation failure during the execution of this method.

See also

GetChildElement

GetChildElements

HasChildElements

HasChildren

IsRootElement

RemoveChildElement

RemoveChildElements Syntax 1

RemoveChildElements Syntax 2