CustomFeatureEvent.remove Method

Parent Object: CustomFeatureEvent

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.


Defined in namespace "adsk::fusion" and the header file is <Fusion/Features/CustomFeatureEvent.h>

Description

Removes a handler from the event.

Syntax

"customFeatureEvent_var" is a variable referencing a CustomFeatureEvent object.
returnValue = customFeatureEvent_var.remove(handler)
"customFeatureEvent_var" is a variable referencing a CustomFeatureEvent object.

#include <Fusion/Features/CustomFeatureEvent.h>

returnValue = customFeatureEvent_var->remove(handler);

Return Value

Type Description
boolean Returns true if removal of the handler was successful.

Parameters

Name Type Description
handler CustomFeatureEventHandler The handler object to be removed from the event.

Version

Introduced in version January 2021