PMDF Programmer's Reference Manual
PMDF-PRM-6.0

Previous | Contents

PMDF_write_subject

Write a Subject: header line to a message being created.

VMS FORMAT

status = PMDF_write_subject (nq_context, subject)

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

C FORMAT

status = PMDFwriteSubject

(nq_context, subject, subject_len)

argument information 
int PMDFwriteSubject (nq_context, subject, subject_len) 
         PMDF_nq **nq_context; 
         char     *subject; 
         int       subject_len;

ARGUMENTS

nq_context

A message enqueue context created with PMDF_start_message_envelope.

subject

Text to place in a Subject: header line; should not include the leading "Subject: ". Length may not exceed 65,535 bytes.

subject_len

Length in bytes of subject.

DESCRIPTION

PMDF_write_subject is a convenience routine for writing a Subject: header line to a message. The call 
PMDF_write_subject (nq_context, 'Meeting at 10:30')
is equivalent to the call 
PMDF_write_line (nq_context, 'Subject: Meeting at 10:30')
PMDF_write_subject 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. Subject: header line not written.
PMDF__INVSTRDES Invalid string descriptor for subject: descriptor has an invalid value in its DSC$B_CLASS field. No Subject: line written.

Previous | Next | Contents