KVOpenDocumentFromSubFileArg

This structure defines the input parameters required to open a subfile as a document. See fpOpenDocumentFromSubFile(). The structure is defined in kvxtract.h.

typedef struct tag_KVOpenDocumentFromSubFileArg
{
    KVStructHeader;

    unsigned int index; /* The sub file index */
    
    DWORD      extractionFlag;    /*A bit-wise flag indicating extra requirements for sub file extraction. */
}
KVOpenDocumentFromSubFileArgRec, *KVOpenDocumentFromSubFileArg;

Member Descriptions

KVStructHeader

The version of the structure. See KVStructHead.

index The index number of the subfile to be opened.

extractionFlag

A bitwise flag that defines additional parameters for file extraction. The following flags are available:

KVExtractionFlag_ExcludeMailHeader

If you set this flag, header information (To, From, Sent, and so on) in a mail file is not included in the extracted data. If you do not set this flag, the extracted data contains header information and the message’s body text.
KVExtractionFlag_GetFormattedBody

If you set this flag, the formatted version of the message body (HTML or RTF) is extracted from mail files when possible. If neither an HTML nor RTF version of the message body exists in the mail file, it is extracted as plain text. If you do not set this flag, the message body is extracted as plain text when possible.

NOTE: When an HTML or RTF message body is extracted, the message’s mail headers (such as "From," "To," and "Subject,") are extracted, saved in the same format, and added to the beginning of the subfile.
KVExtractionFlag_SaveAsMSG

If you set this flag, the mail message is extracted as an MSG file, including all of its attachments. If you do not set this flag, the mail message is extracted as text. This applies to PST files processed using the pstsr and pstxsr readers only.