<info_get_callback>
Abstract
Obtains specified data from the wireless domain’s cache.
Syntax
<info_get_callback> (wdomain_state_ptr, request_flags, xmit_cluster_id, rcv_cluster_id, info_ptr, continuation_ptr)
| Argument | Type | Description |
|---|---|---|
wdomain_state_ptr |
void * |
User-defined state information about the wireless domain, provided by the <init_callback>. |
request_flags |
unsigned int |
Flag indicating requested data values. See Details. |
xmit_cluster_id |
SimT_Wcluster_Id |
Identifier of the cluster containing the transmitting object. |
rcv_cluster_id |
SimT_Wcluster_Id |
Identifier of the cluster containing the receiving object. |
info_ptr |
SimT_Wcluster_Info * |
Memory in which to place the requested data. |
continuation_ptr |
void ** |
Pointer to the cache element corresponding to the specified transmit and receive clusters. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the data is successfully obtained; OPC_COMPCODE_FAILURE otherwise.
Details
The request_flags argument can be any of the following:
OPC_WCLUSTER_INFO_CLOSUREOPC_WCLUSTER_INFO_CHANMATCHOPC_WCLUSTER_INFO_PROPDELOPC_WCLUSTER_INFO_PATHLOSSOPC_WCLUSTER_INFO_ALL
The continuation_ptr argument can be used by the <info_set_callback> (if invoked) for faster access to the cache element corresponding to the specified transmit and receive clusters.
You can rename the arguments, but do not change the function name (<info_get_callback>).