PMDF Programmer's Reference Manual

PMDFrewindMessage

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

PASCAL

status = PMDF_rewind_message (dq_context)

argument information

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

C

status = PMDFrewindMessage (dq_context)

argument information

int PMDFrewindMessage(PMDF_dq **dq_context)

Arguments

dq_context
A message dequeue context created with PMDFdequeueInitialize.

Description

PMDFrewindMessage will "rewind" a message file back to the start of its message header. This routine can be called any time after all of the envelope "To:" addresses have been read with PMDFgetRecipient and prior to dequeuing or deferring the message. After PMDFrewindMessage has been called, the message header can be read with either PMDFreadHeader, PMDFreadLine, or PMDFreadText.

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.

Contents

Index

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.