ACAPI_​Register_​SettingsObserver

Create an observer to an element settings dialog.

    GSErrCode  ACAPI_Register_SettingsObserver (
        API_ElemTypeID          tool,
        API_ElemVariationID     variation,
    );

 

Parameters

tool
[in] The element type that identifies the settings dialog
variation
[in] The element variation that distinguishes the element kinds of the same type

 

Return Values

APIERR_BADPARS
The passed element type is invalid.
APIERR_BADID
The passed tool / variation parameter pair does not identify a valid toolbox item (including invisible tools).
NoError
The function has completed with success.

For other common API errors see the API Errors document.

 

Remarks

This function creates an observer for an element settings dialog specified by tool and variation. In order to get settings dialog create\destroy events you must install the settings handler callback functions with ACAPI_Install_SettingsHandler.

This function should be called from your add-on’s RegisterInterface routine. You can register more than one observers from the same add-on for different settings dialogs.

 

Example

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

 

Requirements

Version: API 20 or later
Header: ACAPinc.h

 

See Also

API_ElemTypeID
API_ElemVariationID
API Functions