op_apptrack_pk_tag_clear()
Abstract
Removes all application message tags from a packet.
Syntax
op_apptrack_pk_tag_clear (apptrack_hndl, pkptr)
| Argument | Type | Description |
|---|---|---|
apptrack_hndl |
Apptrackhandle |
ADT state of interest. |
pkptr |
SimT_Packet * |
Packet of interest. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
None.
Purpose
This KP untags a packet so that it will no longer be tracked.
Errors
- Recoverable Error: Argument (
apptrack_hndl) is NIL. - Program Abort: Packet pointer is NIL.
- Program Abort: Packet pointer references destroyed packet.
- Program Abort: Packet pointer references unowned packet (
<packet ID>). - Program Abort: Packet pointer references static packet (
<packet ID>).
Reference
- Use the KP op_apptrack_pk_tag() to tag a packet.