PMDF Programmer's Reference Manual
PMDF-PRM-6.0

Previous | Contents

PMDF_delete_header_line

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

VMS FORMAT

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 FORMAT

status = PMDFdeleteHeaderLine (header, type)

argument information 
int PMDFdeleteHeaderLine (header, type) 
         PMDF_hdr *header; 
         int       type;

ARGUMENTS

header

Address of a header structure previously created by PMDF_read_header or PMDF_add_header_line.

type

The type of header line being removed.

DESCRIPTION

PMDF_delete_header_line 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 PMDF_delete_header_line specifying HL_OTHER for the header line type.

Previous | Next | Contents