PMDF Programmer's Reference Manual
PMDF-PRM-6.0
Previous
| Contents
PMDF_read_header
Read a message header from a message file.
VMS FORMAT
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 FORMAT
status = PMDFreadHeader (dq_context, header)
argument information
int PMDFreadHeader (dq_context, header)
PMDF_dq **dq_context;
PMDF_hdr **header;
ARGUMENTS
dq_context
A message dequeue context created with PMDF_dequeue_initialize.
header
Address of a header structure created by PMDF_read_header.
DESCRIPTION
PMDF_read_header 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 PMDF_get_recipient has returned PMDF__EOF
or after a call to PMDF_rewind_message. PMDF_write_header may be called
to output a header structure to a message being enqueued.
PMDF_dispose_header 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. |
Previous
| Next
| Contents