PMDF Programmer's Reference Manual
Previous Next Contents Index

PMDFaddHeaderLine

Add a header line to a header structure.

PASCAL

status = PMDF_add_header_line (header, type, line)

argument information
Argument Data type Access Mechanism
header header pointer write reference
type signed longword read value
line descriptor read reference

C

status = PMDFaddHeaderLine

(header, type, line, line_len)

argument information 


int PMDFaddHeaderLine(PMDF_hdr **header, 
                      int        type, 
                      char      *line, 
                      int        line_len)

Arguments

header

Address of a header structure.

type

The type of header line being added.

line

The header line to add. No length limit is imposed.

line_len

The length in bytes of line.

Description

PMDFaddHeaderLine adds a header line of the specified type to the header structure, header. The header structure need not have been created by a previous call to PMDFreadHeader; PMDFaddHeaderLine will initialize the structure if it is nil (zero) on input. The type argument specifies the type of header line being added (e.g., HL_FROM, HL_TO, HL_DATE, etc.). The accepted types are defined in the API include files; see Section 1.6 for further details. Specify HL_OTHER for a header line type not recognized by the API. The full header line, field name, colon, and body, must be specified (e.g., "X-whatever: ariel@example.com"). Header structures can be output with PMDFwriteHeader and disposed of with PMDFdisposeHeader. See Section 1.6 for further details on using and manipulating header structures.

Return Values

PMDF__OK Normal, successful completion.
PMDF__HEANOTKNW Unknown header line type. No header line added. Recall PMDFaddHeaderLine specifying HL_OTHER for the header line type.
PMDF__INVSTRDES Invalid string descriptor for line: descriptor has an invalid value in its DSC$B_CLASS field. No header line added.

Previous Next Contents Index