OvisT_Anim_Reception_Destroy_Proc
Abstract
Callback: Invoked before the simulation kernel destroys a reception object.
Syntax
<anim_reception_destroy_proc_name> (rcpt_ptr, stage, state_ptr)
| Argument | Type | Description |
|---|---|---|
rcpt_ptr |
OvisT_Reception * |
Pointer to the reception object about to be destroyed by the simulation kernel |
stage |
OvisT_Xmit_Stage |
Indicates where in the pipeline sequence the destruction is happening. You can specify one of the following values for this argument:OvisC_Xmit_Stage_ClosureOvisC_Xmit_Stage_ChanmatchOvisC_Xmit_Stage_PowerOvisC_Xmit_Stage_End_SuccessOvisC_Xmit_Stage_End_Failure |
state_ptr |
void * |
Pointer to the state information returned by the OvisT_Anim_Reception_Init_Proc callback. |
Return Type
void
No return value.
Header
ovis_transmission_anim.h
Details
This callback is invoked when a reception object is about to be destroyed. The 'stage' argument indicates where in the pipeline stage this destruction occurs.
This allows any associated user state to be destroyed appropriately.