Next: , Previous: bpipe_dpktf_name, Up: Data Packet Field Manipulations


A.3.11 bpipe_dpktf_next

Return a handle to the next core data packet field.

Synopsis

     #include <bpipe/bpipe.h>
     
     
     
DpktField *bpipe_dpktf_next( BPipe *bpipe, void **p_last );

Parameters

BPipe *bpipe
the binary pipe with which the field is associated
void **p_last
the address of a pointer used to traverse the list

Description

This routine is used when traversing the list of data packet fields. It requires an external pointer which it uses to keep track of where it is in the list. The first call whould be done with that pointer set equal to NULL. Note that the address of the pointer is passed to bpipe_dpktf_next, not the pointer itself. The value shouldn't be changed between calls to this routine. Additions or deletions should not be made to the list in between calls to this routine.

Returns

It returns a pointer to the data packet field's structure. This is used by the data packet field information extraction routines. If the entire list of data packet fields has been traversed, it returns NULL.