axlSDBGetChildren

axlSDBGetChildren(
x_SDBH
[ t_name ]
[ t_value ]
S_returnAs
)
=> l_children / nil

Description

Returns child elements of the provided setup database handle.

Arguments

x_SDBH	Setup database handle
t_name	Optional filtration by element name. If not provided, all child elements of the parent will be returned.
t_value	Optional filtration by element value. If provided, t_name must also be specified.
S_returnAs	Format of the return value. 'handles: Returns a list of the setup database handles of hte child elements. This is the default. 'assoc: Returns a list of name-value pairs, such as ((elt1Name elt1Val) (elt2Name elt2Val)).

Value Returned

l_children	A list corresponding to the value set for s_returnAs is returned.
nil	Indicates an error,

Examples

Returns child elements of the given setup database handle.

;; given x_mainSDB pointing to current setup

extensionSDBH = axlSDBPutExtension( x_mainSDB "test extension")
axlSDBSetChild( extensionSDBH "King" "Louis XIV")

axlSDBGetChildren(extensionSDBH ?name "King" ?returnAs 'assoc) 
=> (("King" "Louis XIV"))

axlSDBSetMultipleEntry( "King")

axlSDBSetChild( extensionSDBH "King" "Henry VII")

axlSDBGetChildren(extensionSDBH ?name "King" ?returnAs 'handles)
=> '(1852 1854)

axlSDBGetChildren(extensionSDBH ?name "King"  ?returnAs 'assoc)
=> (("King" "Louis XIV") ("King" "Henry VII"))

axlSDBGetChildren(extensionSDBH ?name "King" ?value "Louis XIV" ?returnAs 'assoc)
=> (("King" "Louis XIV"))

Return to top