Ets_Nt_Time_Change_Callback_Register()
Abstract
Registers a time change callback.
Syntax
Ets_Nt_Time_Change_Callback_Register (model_hndl, callback_tag, callback, user_state_ptr)
| Argument | Type | Description |
|---|---|---|
model_hndl |
EtsT_Model_Handle |
Network model with which to register the callback. |
callback_tag |
const char * |
Name of the callback to register. |
callback |
EtsT_Nt_Time_Change_Callback |
Callback to register. |
user_state_ptr |
void * |
User-defined state information to be passed to the callback when it is invoked. |
Return Type
void *
Returns the previously registered user_state_ptr if the callback was registered previously; PRGC_NIL otherwise.
Header
ets_api_nt.h
Details
The time change callback is a user-defined function that will be called whenever the time visualized in a network changes. You can register multiple time change callbacks with the same network model. The callback_tag identifies a particular time change callback when checking whether it has been registered before or when deregistering it.
The prototype for a time change callback is given in EtsT_Nt_Time_Change_Callback.