Previous | Next | Contents | Index |
Read a message header from a message file.
argument informationstatus = PMDF_read_header (dq_context, header)
Argument | Data type | Access | Mechanism |
---|---|---|---|
dq_context | context pointer | read/write | reference |
header | header pointer | write | reference |
argument informationstatus = PMDFreadHeader (dq_context, header)
int PMDFreadHeader(PMDF_dq **dq_context, PMDF_hdr **header) |
dq_context
A message dequeue context created withPMDFdequeueInitialize
.header
Address of a header structure created byPMDFreadHeader
.
PMDFreadHeader
will, in a single call, read the entire message header from a message. The "read point" for the message must be positioned at the start of the message header. This will be the case immediately after a call toPMDFgetRecipient
has returnedPMDF__EOF
or after a call toPMDFrewindMessage
.PMDFwriteHeader
can be called to output a header structure to a message being enqueued.PMDFdisposeHeader
should be called to dispose of a previously read header. See Section 1.6 for details on using and manipulating header structures.
PMDF__OK Normal, successful completion. PMDF__BADCONTEXT Illegal or corrupt context. Header not read.
Previous | Next | Contents | Index |