This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
Bz removeEvent: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Added return value. |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{apicall | {{apicall | ||
| name = bz_removeEvent | | name = bz_removeEvent | ||
| returns = Whether or not the event was removed successfully. | |||
| returntype = bool | |||
| description = Removes the specified event listener. The event listener must previously have been added by a call to [[bz_registerEvent]]. | | description = Removes the specified event listener. The event listener must previously have been added by a call to [[bz_registerEvent]]. | ||
| param1 = eventType | | param1 = eventType | ||
| Line 9: | Line 11: | ||
| param2desc = The listener to remove. | | param2desc = The listener to remove. | ||
}} | }} | ||
===Deprecation=== | |||
All calls to [[bz_removeEvent]] in the [[bz_Unload]] have been deprecated as of 2.4 and will be replaced with: | |||
# '''Flush();''' | |||
More information on this function can be found on the [[BZFS_API_2.4_Upgrade]] page. | |||
Latest revision as of 05:53, 19 October 2011
bool bz_removeEvent (bz_eEventType eventType, bz_EventHandler* listener)
Removes the specified event listener. The event listener must previously have been added by a call to bz_registerEvent.
Parameters:
eventType - The type of event that this listener was previously registered to handle. This is so that if this listener is registered for multiple event types, only one of those will be removed.
listener - The listener to remove.
Returns:
Whether or not the event was removed successfully.
Deprecation
All calls to bz_removeEvent in the bz_Unload have been deprecated as of 2.4 and will be replaced with:
# Flush();
More information on this function can be found on the BZFS_API_2.4_Upgrade page.