PMDF Programmer's Reference Manual

PMDFreadHeader

Read a message header from a message file.

PASCAL

status = PMDF_read_header (dq_context, header)

argument information

Argument	Data type	Access	Mechanism
dq_context	context pointer	read/write	reference
header	header pointer	write	reference

C

status = PMDFreadHeader (dq_context, header)

argument information

int PMDFreadHeader(PMDF_dq **dq_context, PMDF_hdr **header)

Arguments

dq_context
A message dequeue context created with PMDFdequeueInitialize.
header
Address of a header structure created by PMDFreadHeader.

Description

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 to PMDFgetRecipient has returned PMDF__EOF or after a call to PMDFrewindMessage. 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.

Return Values

PMDF__OK Normal, successful completion.

PMDF__BADCONTEXT Illegal or corrupt context. Header not read.

Contents

Index

PMDF__OK	Normal, successful completion.
PMDF__BADCONTEXT	Illegal or corrupt context. Header not read.