KVExtractSubFileArg

This structure defines the input parameters required to extract a subfile. See fpExtractSubFile(). The structure is defined in kvxtract.h.

typedef struct tag_KVExtractSubFileArg
{
    KVStructHeader;
    int                index;
    KVCharSet          srcCharset;
    KVCharSet          trgCharset; 
    int                isMSBLSB;
    DWORD              extractionFlag
    char              *filePath; 
    char              *extractDir;
    KVOutputStream    *stream;
}
KVExtractContainerSubFileArgRec, *KVExtractContainerSubFileArg;

Member Descriptions

KVStructHeader The KeyView version of the structure. See KVStructHead.
index The index number of the subfile to be extracted.
srcCharset Specifies the source character set of the subfile when the file format’s reader cannot determine the character set. The character sets are enumerated in KVCharSet of kvtypes.h. See KVExtractSubFileArg.
trgCharset If the file type is KVFileType_Main, this is the target character set of the extracted file. Otherwise, this is ignored. The character sets are enumerated in KVCharSet in kvtypes.h. See KVExtractSubFileArg.
isMSBLSB This flag indicates whether the byte order for Unicode text is Big Endian (MSBLSB) or Little Endian (LSBMSB).
extractionFlag

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

  • KVExtractionFlag_CreateDir

    This flag indicates whether the directory structure of a subfile should be created. If you set this flag, the path defined in filePath is created if it does not already exist. If you do not set this flag, the path is not created, and the function returns FALSE.

  • KVExtractionFlag_Overwrite

    If you set this flag, and the file being extracted has the same name as a file in the target path, the file in the target path is overwritten without warning. If you do not set this flag, and a subfile has the same name as a file in the target path, the error KVError_OutputFileExists is generated.

  • 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. See Exclude Metadata from the Extracted Text File.

  • 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: 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. This applies to PST (MAPI-based reader), MSG, and NSF files only.

  • 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 on Windows only.

NOTE: Note: In file mode, when the application sets this flag in fpExtractSubFile(), it must also check the KVSubFileExtractInfo structure’s filePath parameter to verify the file name used for extraction.
filePath A pointer to the suggested path or file name to which the subfile is extracted. This can be a file name, partial path, or full path. You can use this in conjunction with extractDir to create the full output path. See KVExtractSubFileArg.
extractDir A pointer to the directory to which subfiles are extracted. This directory must exist. If you set this flag, the path specified in KVOpenFileArg->extractDir is ignored. You can use this in conjunction with filePath to create the full output path.
stream A pointer to an output stream defined by KVOutputStream. See KVExtractSubFileArg below.

Discussion


_HP_HTML5_bannerTitle.htm