PMDF Programmer's Reference Manual
PMDF-PRM-6.0

Access the next message in the message queue being processed.

VMS FORMAT

status = PMDF_get_message

(dq_context, filename, filename_len, from, from_len)

C FORMAT

status = PMDFgetMessage

(dq_context, filename, filename_len, from, from_len)

int PMDFgetMessage (dq_context, filename, filename_len, 
                    from, from_len) 
         PMDF_dq **dq_context; 
         char     *filename; 
         int      *filename_len; 
         char     *from; 
         int      *from_len; 

ARGUMENTS

dq_context

A message dequeue context created with PMDF_dequeue_initialize.

filename

String to receive the name of the file containing the accessed message. Length must be at least ALFA_SIZE bytes. (ALFA_SIZE+1 bytes for PMDFgetMessage.)

filename_len

Length in bytes of the returned file name. Callers using PMDFgetMessage must, on input, supply the maximum length in bytes of filename.

from

String to receive the envelope From: address of the accessed message. Length must be at least ALFA_SIZE bytes. (ALFA_SIZE+1 bytes for PMDFgetMessage.)

from_len

Length in bytes of the envelope From: address. Callers using PMDFgetMessage must, on input, supply the maximum length in bytes of from.

DESCRIPTION

PMDF_get_message should be called repeatedly to access, one at a time, each message requiring processing. Each message to be processed will only be presented once; i.e., a job will not repeatedly see a message which it has deferred. When PMDF_get_message returns the status code PMDF__EOF, no more messages remain to be processed. The returned envelope From: address should be saved as it may be needed if the program either enqueues a new message or returns the accessed message. The returned file name can usually be ignored as the API routines manage all access to the message file including opening the file, reading it, closing it, and deleting it when it is dequeued. A message accessed with PMDF_get_message may be processed using any of the routines accepting a dq_context argument. After processing an accessed message, the message should de-accessed with PMDF_dequeue_message_end.