op_apptrack_pk_add_protocol_info()
Abstract
Adds protocol-specific information to an application instance.
Syntax
op_apptrack_pk_add_protocol_info (apptrack_hndl, pkptr, objid, protocol, info_ptr, info_size)
| Argument | Type | Description |
|---|---|---|
apptrack_hndl |
Apptrackhandle |
ADT state of interest. |
pkptr |
SimT_Packet * |
Packet of interest. |
objid |
Objid |
Object ID of the node that created the packet. |
protocol |
int |
ID of the protocol used by the packet. |
info_ptr |
void * |
Pointer to the protocol information. |
info_size |
int |
Size of the protocol information. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
The added information comes from a protocol-specific structure. The available structures are defined in p_apptrack_type.h.
Purpose
This KP provides a way to add protocol-specific information to an application instance. This additional information permits various happening times to be recorded for custom needs.
Errors
- None.
Reference
- None.