EtsT_Nt_Clipboard_Filter_Callback
Note: Requires OPNET Development Kit
Abstract
Callback: Called when a cut/copy/delete operation is invoked and a callback function is needed to process the operation.
Syntax
<clipboard_filter_proc_name> (nt_model_hndl, obj_hndl, op, state_ptr)
| Argument | Type | Description |
|---|---|---|
nt_model_hndl |
EtsT_Model_Handle |
Network model containing the objects to be cut/copied/deleted. |
obj_hndl |
EtsT_Obj_Handle |
Handle to the object that is a candidate to be placed in the clipboard |
op |
EtsT_Nt_Clipboard_Operation | Name of the clipboard operation to be invoked; one of the values given in Table 30 Network Callback Symbolic Constants. |
state_ptr |
void * |
User-defined state information to be passed to the callback when it is invoked. |
Return Type
int
Integer that indicates whether the selected object should be cut/copied/deleted.
Header
ets_api_nt_cback.h
Details
A clipboard-filter callback function is useful when cutting/copying/deleting objects might have undesirable effects, and a callback is needed to filter objects before they are placed in the clipboard and/or removed from the scenario. This callback is invoked for each selected object; the object will be filtered only if the callback returns a non-zero ("true") integer value for that object.
This callback is registered by Ets_Nt_Clipboard_Filter_Register().