Description
The GetChildElements method is overloaded:
-
Syntax 1 retrieves a list of all child PBDOM_ELEMENT objects nested one level deep within a PBDOM_ELEMENT object. The list is stored in the array specified when the method is invoked.
-
Syntax 2 retrieves a list of all child PBDOM_ELEMENT objects nested one level deep within a PBDOM_ELEMENT object specified by the name provided and belonging to no namespace. The list is stored in the array specified when the method is invoked.
-
Syntax 3 retrieves a list of all child PBDOM_ELEMENT objects nested one level deep within a PBDOM_ELEMENT object specified by the local name and namespace provided.
Syntax
|
For this syntax |
See |
|---|---|
GetChildElements(ref pbdom_element pbdom_element_array[]) |
|
GetChildElements(string strElementName, ref pbdom_element pbdom_element_array[]) |
|
GetChildElements(string strElementName, string strNamespacePrefix, string strNamespaceUri, ref pbdom_element pbdom_element_array[]) |
Description
Retrieves a list of all child PBDOM_ELEMENT objects nested one level deep within a PBDOM_ELEMENT object. The list is stored in the array specified when the method is invoked.
Syntax
pbdom_element_name.GetChildElements(ref pbdom_element pbdom_element_array)
|
Argument |
Description |
|---|---|
|
pbdom_element_name |
The name of a PBDOM_ELEMENT object |
|
pbdom_element_array |
The array that stores the child PBDOM_ELEMENT objects |
Return value
Boolean.
Returns true if child PBDOM_ELEMENT objects have been collected, and false otherwise.
Usage
If the PBDOM_ELEMENT object has no nested elements, GetChildElements returns an empty array.
See also
Description
Retrieves a list of all child PBDOM_ELEMENT objects nested one level deep within a PBDOM_ELEMENT object specified by the name provided and belonging to no namespace. The list is stored in the array specified when the method is invoked.
Syntax
pbdom_element_name.GetChildElements(string strElementName, ref pbdom_element pbdom_element_array[])
|
Argument |
Description |
|---|---|
|
pbdom_element_name |
The name of a PBDOM_ELEMENT object |
|
strElementName |
The name of the PBDOM_ELEMENT object for which to find children |
|
pbdom_element_array |
The array that stores the child PBDOM_ELEMENT objects |
Return value
Boolean.
Returns true if child PBDOM_ELEMENT objects have been collected, and false otherwise.
Usage
If the PBDOM_ELEMENT object has no nested elements, GetChildElements returns an empty array.
See also
Description
Retrieves a list of all child PBDOM_ELEMENT objects nested one level deep within a PBDOM_ELEMENT object specified by the local name and namespace provided.
Syntax
pbdom_element_name.GetChildElements(string strElementName, string strNamespacePrefix, string strNamespaceUri, ref pbdom_element pbdom_element_array[])
|
Argument |
Description |
|---|---|
|
pbdom_element_name |
The name of a PBDOM_ELEMENT object |
|
strElementName |
The name of a PBDOM_ELEMENT object for which to find children |
|
strNamespacePrefix |
The prefix of the namespace of the child PBDOM_ELEMENT objects to match |
|
strNamespaceUri |
The URI of the namespace of the child PBDOM_ELEMENT objects to match |
|
pbdom_element_array[] |
The array that stores the child PBDOM_ELEMENT objects |
Return value
Boolean.
Returns true if child PBDOM_ELEMENT objects have been collected, and false otherwise.
Throws
EXCEPTION_INVALID_ARGUMENT -- If any of the parameters is invalid.
EXCEPTION_INVALID_NAME -- If the input element name or namespace prefix or namespace URI is invalid. The only exception is if the input element name is an empty string.
Usage
If the PBDOM_ELEMENT object has no nested elements, GetChildElements returns an empty array.
If the value of strElementName is an empty string, then all child elements match.
See also
