KVOpenFileArg
This structure defines the input arguments necessary to open a file for extraction. This structure is defined in kvxtract.h
.
To open a file for extraction, initialize a KVOpenFileArg
structure and pass it to the function fpOpenFile(). To specify the input document you should set one the members stream
, filePath
, or document
, and set the other two to NULL
.
typedef struct tag_KVOpenFileArg { KVStructHeader; KVCredential cred; KVInputStream *stream; char *filePath; KVDocument document; char *extractDir; DWORD openFlag; DWORD reserved; void *pReserved; } KVOpenFileArgRec, *KVOpenFileArg;
Member Descriptions
KVStructHeader
|
The KeyView version of the structure. See KVStructHead. |
cred
|
The credentials required to open a protected PST or NSF file. This is a pointer to the KVCredential structure. Your application can define multiple credentials to this member for multiple formats. |
stream
|
A pointer to the developer-assigned instance of |
filePath
|
A pointer to the full file path to the source file. |
document
|
A You can create a |
extractDir
|
A pointer to the default directory to which subfiles are extracted. This directory must exist. You can use this in conjunction with |
openFlag
|
A bitwise flag that defines additional parameters for opening the file. The following flag is available:
If you want to maintain the file’s hierarchy when you extract subfiles from a container, you must set this flag. See Understand the Subfile Hierarchy for more information. The root node has an index of zero. Although not all container formats require an artificial root node, the root is created for all container formats regardless of whether the file itself contains a root directory or file. |
reserved
|
Reserved for future use. It must be NULL . |
pReserved
|
Reserved for future use. It must be NULL . |
Discussion
-
On Windows,
filePath
andextractDir
must be in the local Windows code page.