Next: , Previous: bpipe_dpktf_init, Up: Data Packet Field Manipulations   [Contents]


A.3.9 bpipe_dpktf_matrix

retrieve a copy of one of a data packet field’s matrix descriptions

Synopsis

#include <bpipe/bpipe.h>

BPMatrix *bpipe_dpktf_matrix(
  DpktField *dpktf,
  BPDataSite site,
  BPipeOutput *channel
);

Parameters

DpktField *dpktf

a pointer to the data packet field structure from which to extract the matrix

BPDataSite site

the image site the matrix spec refers to


Possible values for a BPDataSite are as follows: BPDSite_INPUT, BPDSite_CORE, BPDSite_OUTPUT

BPipeOutput *channel

the output channel handle if requesting matrix spec for an output channel

Description

This routine makes a copy of the matrix specification associated with the specified image of a data packet field and returns a pointer to it.

Returns

This routine returns a pointer to a BPMatrix structure upon success. If an error occurs, it returns NULL and sets bpipe_errno.

Errors

Upon error bpipe_errno is set to one of the following:

BPEBADARG
BPENOMEM

a memory allocation failed