Sun Java System Messaging Server 6 2005Q4 MTA Developer's Reference

mtaDequeueRewind()

Reset the read point to the start of the message.

Syntax

int mtaDequeueLineNext(mta_dq_t *dq_ctx);

Arguments

Arguments  

Description  

dq_ctx

A dequeue context created by mtaDequeueStart().

Description

Repositions the read point back to the start of the message.

After obtaining a message’s recipient list by repeated calls to mtaDequeueRecipientNext(), the read point into the underlying message file is positioned at the start of the actual message. Specifically, at the start of the message’s outermost header. Calling mtaDequeueLineNext() advances this read point, with each call moving it towards the end of the message. To reposition the read point back to the start of the message (that is, to the start of the message’s outermost header), call mtaDequeueRewind(). Use this call if a program needs to make a second pass through a message. For example, a program might scan a message’s content before actually processing it.

Return Values

Return Values  

Description  

0

Normal, successful completion. 

MTA_BADARGS

A NULL value was supplied for the dq_ctx call argument, or an invalid dequeue context was supplied for dq_ctx.

MTA_ORDER

Call made out of sequence. The call was made either before the recipient list has been exhausted with mtaDequeueRecipientNext(), or after the message had been dequeued or deferred with mtaDequeueMessageFinish().

MTA_THREAD

The MTA SDK detected simultaneous use of the dequeue context by two different threads. 

Example

None