PMDF Programmer's Reference Manual
PMDF-PRM-6.0


Previous | Contents

PMDF_write_from

Write a From: header line to a message being enqueued.

VMS FORMAT

status = PMDF_write_from (nq_context, from)

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

C FORMAT

status = PMDFwriteFrom

(nq_context, from, from_len)

argument information
int PMDFwriteFrom (nq_context, from, from_len) 
         PMDF_nq **nq_context; 
         char     *from; 
         int       from_len; 

ARGUMENTS

nq_context

A message enqueue context created with PMDF_start_message_envelope.

from

Envelope From: address for the message to be enqueued. Length may not exceed ALFA_SIZE bytes.

from_len

Length in bytes of the envelope From: address.

DESCRIPTION

PMDF_write_from will output a From: header line to a message header. The address cited in the header line will be that supplied with the from argument. PMDF_write_from should be called after PMDF_start_message_header and prior to calling PMDF_start_message_body. If it is called after PMDF_start_message_body, then it's output will become part of the message body.
Return Values
PMDF__OK Normal, successful completion.
PMDF__BADCONTEXT Illegal or corrupt context. Date: header line not written.
PMDF__INVSTRDES Invalid string descriptor for from: descriptor has an invalid value in its DSC$B_CLASS field. Header line not written.
PMDF__STRTRUERR The from input string is too long. Header line not written.


Previous | Next | Contents