Advanced: Creating Customized OSIs : Customizing API Definitions : General API Definitions : Event APIs

Event APIs
 
Sample Description
Code Generated
Declare Event(nameid, itstaskid)
Defines the code for declaring an Event (OS Object).
This API is used when generating the code for declaring a Task Event
The code is generated in the file type_def.h
For an Event defined to be a Task-Event.
API definition: DECLARE_EVENT($nameid);
Generated Code: DECLARE_EVENT(EV1);
Define Event(nameid, itstaskid)
Defines the code for defining an Event (OS Object).
This API is used when generating the code for defining a Task Event.
The code is generated in the file glob_dat.c
For an Event defined to be a Task-Event.
API definition: DEFINE_EVENT($nameid);
Generated Code: DEFINE_EVENT(EV1);
Create Event(nameid, itstaskid)
Defines the code for creating an Event (OS Object).
This API is used when generating the code for creating a Task Event.
The code is generated in the file glob_dat.c, in the function: on_startup_code.
The function on_startup_code is called at the startup of the generated application.
For an Event defined to be a Task-Event.
API definition: CREATE_EVENT($nameid);
Generated Code: CREATE_EVENT(EV1);
Destroy Event(nameid, itstaskid)
Defines the code for destroying an Event (OS Object).
This API is used when generating the code for destroying a Task Event.
The code is generated in the file glob_dat.c, in the function on_exit_code.
The function on_exit_code is called at the end of the generated application.
For an Event defined to be a Task-Event.
API definition: DESTROY_EVENT($nameid);
Generated Code: DESTROY_EVENT(EV1);
Clear Event(nameid, itstaskid)
Defines the code for clearing an Event (OS object).
This API defines the code for clearing a single Task Event.
The definition of this API will be used only if there is no definition for ClearMultipleEvent()
For Tasks that have Task-Event related to them, the code of this API will be generated in the Task's code frame, after the code for the API: Get Event().
The definition of this API will be generated in the file <module>.c
For an Event defined to be a Task-Event.
API definition: CLEAR_EVENT($nameid);
Generated Code: CLEAR_EVENT(EV1);
Defines the code for getting an Event (OS Object).
This API defines the code for clearing a single Task Event.
The definition of this API will be used only if there is no definition for GetMultipleEvent()
For Tasks that have Task-Event related to them, the code of this API will be generated in the Task's code frame, after the code for the API: Wait Event().
The definition of this API will be generated in the file <module>.c
For an Event defined to be a Task-Event.
API definition: GET_EVENT($nameid);
Generated Code: GET_EVENT(EV1);
Defines the code for setting an Event (OS Object).
This API defines the code for setting a single Task Event.
The definition of this API will be used in the definition of the GENERATE_EVENT macro for Events that are defined to be a Task Event.
The macro is generated in the file macro_def.h
For an Event defined to be a Task-Event.
API definition: SET_EVENT($nameid);
Generated Code: SET_EVENT(EV1);
Defines the code for waiting for an Event (OS Object).
Test for Event(nameid, itstaskid)
Defines the code for testing an Event (OS Object).
This API defines the code for testing if a single Task Event was generated.
For Tasks that have Task-Event related to them, the code of this API will be generated in the Task's code frame, after the code for the API: Get Event().
For an Event defined to be a Task-Event.
API definition: TEST_EVENT($nameid);
Generated Code: TEST_EVENT(EV1);