PMDF Programmer's Reference Manual
Previous Next Contents Index

PMDFwriteSubject

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

PASCAL

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

status = PMDFwriteSubject

(nq_context, subject, subject_len)

argument information 


int PMDFwriteSubject(PMDF_nq **nq_context, 
                     char     *subject, 
                     int       subject_len)

Arguments

nq_context

A message enqueue context created with PMDFstartMessageEnvelope.

subject

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

subject_len

Length in bytes of subject.

Description

PMDFwriteSubject is a convenience routine for writing a "Subject:" header line to a message. The call 


PMDFwriteSubject(nq_context, "Meeting at 10:30");
is equivalent to the call 


PMDFwriteLine(nq_context, "Subject: Meeting at 10:30");
PMDFwriteSubject should be called after PMDFstartMessageHeader and prior to calling PMDFstartMessageBody. If it is called after PMDFstartMessageBody, 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 Index