PMDF Programmer's Reference Manual

PMDFdeleteHeaderLine

Remove all header lines of a given type from a header structure.

PASCAL

status = PMDF_delete_header_line (header, type)

argument information

Argument	Data type	Access	Mechanism
header	header pointer	read	value
type	signed longword	read	value

C

status = PMDFdeleteHeaderLine (header, type)

argument information

int PMDFdeleteHeaderLine(PMDF_hdr *header, int type)

Arguments

header
Address of a header structure previously created by PMDFreadHeader or PMDFaddHeaderLine.
type
The type of header line being removed.

Description

PMDFdeleteHeaderLine removes all header lines of the type type from the header structure pointed at by header. That is, the linked list
header[type]
will be disposed of. The type argument specifies the type of header lines to be removed (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.

Return Values

PMDF__OK Normal, successful completion.

PMDF__HEANOTKNW Unknown header line type. No header lines removed. Recall PMDFdeleteHeaderLine specifying HL_OTHER for the header line type.

Contents

Index

PMDF__OK	Normal, successful completion.
PMDF__HEANOTKNW	Unknown header line type. No header lines removed. Recall `PMDFdeleteHeaderLine` specifying HL_OTHER for the header line type.