QPR Knowledge Base 2019.1

Revision history:

Introduced in QPR 2015.1

 

Returns the child elements of given elementId in given hierarchy.

 

Synopsis:

 

PGModel.GetChildElements(Hierarchy, ElementId, out arrayOfChildElementIds)

 

Parameters:

 

Hierarchy: Hierarchy ID (integer) or Hierarchy Symbol (string). The hierarchy id or hierarchy symbol for the hierarchy where the element exists.

ElementId: ElementId (integer) or ElementSymbol (string). The element id or symbol of the element whose children are acquired.

arrayOfChildElementIds: Array of child element ids. Returns NULL if no children are found.

 

Required Rights:

 

View rights to the model.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_SUCCESS

RV_APPLICATION_QUIT_CALLED

RV_HIERARCHY_NOT_FOUND

RV_INVALID_PARAMETER

 

 

Example Procedure:

 

 iResult = PGModel.GetChildElements(Hierarchy="H2", ElementId="MO1428971049", iChildArray)