op_apptrack_pk_type_info_get()
Abstract
Gets the application type IDs in a packet.
Syntax
op_apptrack_pk_type_info_get (apptrack_hndl, pkptr, num_types, app_types_array)
| Argument | Type | Description |
|---|---|---|
apptrack_hndl |
Apptrackhandle |
ADT state of interest. |
pkptr |
SimT_Packet * |
Packet of interest. |
num_types |
int * |
Area to be filled with the size of app_types_array. |
app_types_array |
opT_uInt32 ** |
Area to be filled with an array of application type IDs. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
The user is responsible for freeing the returned array.
Purpose
This KP returns an array of all application type IDs carried in a tagged packet. This can be useful during packet segmentation and reassembly, which can cause a packet to have multiple application types.
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>). - Recoverable Error: Argument (
num_types) is NIL. - Recoverable Error: Argument (
app_types_array) is NIL. - Recoverable Error: Application instance (
<instance_id>) is invalid or has been completed.
Reference
- Use the KP op_apptrack_pk_tag() to add an application type ID to a packet.