MailHeaderLen

The MailHeaderLen function computes the number of characters in a header string.

Syntax

DWORD MailHeaderLen (MailMsg* pmm);

At a Glance

Header file:	Msgstore.h
Platforms:	H/PC
Versions:	1.0 and later

Parameters

pmm: Mail message containing the header whose length is returned.

Return Values

This function returns the length, in characters, of the entire header string.

Remarks

The MailHeaderLen function searches the header (that is, the pwcHeaders field) of the MailMsg structure in memory. Before calling MailHeaderLen, the message must be retrieved from the message store by calling MailGet, MailFirst, or MailNext.

The pwcHeaders member of the MailMsg structure points to the message's header string. The header consists of entries made up of two fields: a name, and an associated value. The name fields are separated from the value fields by a NULL character, and the entries are separated from each other by a NULL character. The header string is terminated with two consecutive NULL characters.