hdbExplainStop

hdbExplainStop(
t_indentation
h_pathVectorId
) 
=> t_string

Description

Explains why a stop was declared.

Arguments

t_indentation	The indentation string that precedes each line.
h_pathVectorId	A path vector ID; something returned by hdbCreatePathVector.

Value Returned

t_string

A string that explains why a stop was declared.

Example

whyStopStr = hdbExplainStop("    " pathVector)

An example for the use of this function can also be found at:

your_install_dir/tools/hdb/examples/hdbTraverse.il

Related Topics

Hierarchy Database Functions

Occurrence Property Functions

Parent/Child Database Functions

Return to top