PMDF Programmer's Reference Manual

PMDFdequeueMessage

Remove a message from PMDF's message queues.

PASCAL

status = PMDF_dequeue_message (dq_context)

argument information

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

C

status = PMDFdequeueMessage (dq_context)

argument information

int PMDFdequeueMessage(PMDF_dq **dq_context)

Arguments

dq_context
A message dequeue context created with PMDFdequeueInitialize.

Description

NOTE: Although still supported, this routine is now considered obsolete. Instead use the PMDFdequeueMessageEnd routine. If calls to PMDFrecipientDisposition were made prior to calling PMDFdequeueMessage, then PMDF will automatically generate any required notification messages when PMDFdequeueMessage is called. Once any notification messages have been generated, the message being dequeued is then permanently removed from the message queue.

Return Values

PMDF__OK Normal, successful completion.

PMDF__BADCONTEXT Illegal or corrupt context. Message not dequeued.

Contents

Index

PMDF__OK	Normal, successful completion.
PMDF__BADCONTEXT	Illegal or corrupt context. Message not dequeued.