APINavigator_​GetNavigatorVPItemChildrenID

Gets the list of child viewpoint groups/nodes of a Navigator viewpoint root or group.

    GSErrCode ACAPI_Navigator (
        APINavigator_GetNavigatorVPItemChildrenID,
        const API_Guid*          guid,
        GS::Array<API_Guid>*     childrenGuids
    );

 

Parameters

guid
[in] The GUID of the root/group of which the children are to be queried.
childrenGuids
[out] The GUIDs of the children.

 

Return Values

NoError
The function has completed with success.
APIERR_BADPARS
guid was nullptr.
childrenGuids was nullptr.
APIERR_BADID
guid does not designate an existing Navigator viewpoint root or group.

For other common API errors see the API Errors document.

 

Example

See in the documentation of APINavigator_GetNavigatorVPRootGroupsID.

 

Requirements

Version: API 22 or later
Header: APIdefs_Navigator.h

 

See Also

APINavigator_GetNavigatorVPRootGroupsID,
ACAPI_Navigator,
API Functions