| LPCTSTR WINAPI MimeGetMessageHeader(
|
| |
HMESSAGE hMessage, |
|
| |
LPCTSTR lpszHeader |
|
| );
|
The MimeGetMessageHeader function returns a pointer to
the value associated with the specified header field in the current
message part.
Parameters
- hMessage
- Handle to the message.
- lpszHeader
- Pointer to the null-terminated string which specifies the
message header. This value cannot be NULL.
Return Value
If the function succeeds, the return value is a pointer to the
header value. If the header field does not exist, a NULL pointer is
returned. To get extended error information, call
MimeGetLastError.
Remarks
Each part in a multipart message has one or more header fields.
To obtain header values for the main message, rather than the
message attachments, the current part number must be set to zero
using the MimeSetMessagePart function.
For languages other than C/C++, it may be preferable to use the
MimeGetMessageHeaderEx function which copies the header
value into a string buffer rather than returning a pointer to the
header value itself.
Requirements
Client: Requires Windows 7, Windows Vista or Windows
XP.
Server: Requires Windows Server 2008 or Windows Server
2003.
Header: Include cstools7.h.
Library: Use csmsgav7.lib.
Unicode: Implemented as Unicode and ANSI versions.
See Also
MimeEnumMessageHeaders, MimeGetFirstMessageHeader,
MimeGetMessageHeaderEx,
MimeGetMessagePart, MimeGetNextMessageHeader,
MimeParseHeader, MimeSetMessageHeader, MimeSetMessagePart
|