UserInterfaceGeneralEvent.remove Method

Parent Object: UserInterfaceGeneralEvent
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/UserInterfaceGeneralEvent.h>

Description

Removes a handler from the event.

Syntax

"userInterfaceGeneralEvent_var" is a variable referencing a UserInterfaceGeneralEvent object.
returnValue = userInterfaceGeneralEvent_var.remove(handler)
"userInterfaceGeneralEvent_var" is a variable referencing a UserInterfaceGeneralEvent object.

#include <Core/UserInterface/UserInterfaceGeneralEvent.h>

returnValue = userInterfaceGeneralEvent_var->remove(handler);

Return Value

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

Parameters

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

Version

Introduced in version March 2017