PMDF Programmer's Reference Manual


Previous Next Contents Index


PMDFstartMessageBody

Begin the body of a message which is being enqueued.

PASCAL

status = PMDF_start_message_body (nq_context)

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

C

status = PMDFstartMessageBody (nq_context)

argument information


int PMDFstartMessageBody(PMDF_nq **nq_context) 


Arguments

nq_context

A message enqueue context created with PMDFstartMessageEnvelope.

Description

After the message header has been written, PMDFstartMessageBody should be called to begin the message body. If the message has no body, then PMDFenqueueMessage should be called without calling PMDFstartMessageBody. After PMDFstartMessageBody has been called, either PMDFwriteLine or PMDFwriteText must be used to write the message body. Once the message body is complete, PMDFenqueueMessage should be used to enqueue the message.

Return Values

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


Previous Next Contents Index