Retrieves a navigator item.

    GSErrCode ACAPI_Environment (
        APIEnv_GetNavigatorItemID,
        const API_Guid*        guid,
        API_NavigatorItem*     navigatorItem
    );

 

Parameters

guid 

[in] The GUID of the navigator item

navigatorItem

[in/out] Data of the navigator item (you should set mapId for performance).

 

Return Values

NoError

The function has completed with success.

APIERR_BADPARS

The guid or the navigatorItem parameter is nullptr, or contains invalid data.

APIERR_GENERAL

No open project.

 

Remarks

This function is used to get an item of the Project Navigator.

 

Example

Refer to the Navigator_Test example project of the API Development Kit.

 

Requirements

Version: API 4.3 or later

Header: APIdefs_Environment.h

 

See Also

API_NavigatorItem
APIEnv_GetNavigatorParentItemID
APIEnv_GetNavigatorChildrenItemsID
ACAPI_Environment
API Functions