PMDF Programmer's Reference Manual
PMDF-PRM-6.0

Previous | Contents

PMDF_rewind_message

Rewind a message file back to the start of its message header.

VMS FORMAT

status = PMDF_rewind_message (dq_context)

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

C FORMAT

status = PMDFrewindMessage (dq_context)

argument information 
int PMDFrewindMessage (dq_context) 
         PMDF_dq **dq_context;

ARGUMENTS

dq_context

A message dequeue context created with PMDF_dequeue_initialize.

DESCRIPTION

PMDF_rewind_message will "rewind" a message file back to the start of its message header. This routine may be called any time after all of the envelope To: addresses have been read with PMDF_get_recipient and prior to dequeuing or deferring the message. After PMDF_rewind_message has been called, the message header may be read with either PMDF_read_header, PMDF_read_line, or PMDF_read_text.
Return Values
PMDF__OK Normal, successful completion.
PMDF__BADCONTEXT Illegal or corrupt context. Message was not rewound.
PMDF__NO There is some sort of inconsistency in the message file; the message cannot be rewound.

Previous | Next | Contents