This function provides a way to enable and configure various options prior to document filtering, such as providing a password for a file, or enabling hidden text extraction.
BOOL pascal fpFilterConfig( void *pContext, int nType, int nValue, void *pData );
pContext
|
A pointer returned from fpInit() or fpInitWithLicenseData(). |
nType
|
The configuration flag. This is a symbolic constant defined in kvtypes.h . The available options are described in the Filter Configuration Flags table. |
nValue
|
The integer value defined for the flags above. |
pData
|
The data for the configuration flag. |
TRUE
.FALSE
.fpFilterConfig()
does not run out of process, any configuration flags that are set through fpFilterConfig()
are passed to the out-of-process session.Flag | Description |
---|---|
KVFLT_SETOOPSRCFILE
|
If you set this flag to
|
KVFLT_SETTEMPDIRECTORY
|
This flag enables you to specify the directory where temporary files created during filtering processes are stored.
|
KVFLT_LOGICALPDF
|
This flag extracts paragraphs from a PDF file in the order in which they appear on the page (logical reading order). The
|
KVFLT_SETXMLCONFIGINFO
|
This flag enables you to define which elements and attributes are extracted from XML documents with a specified format ID or root element. You can use this option to override the default settings for the supported XML formats (see Filter XML Files), or to define settings for custom XML document types. The settings are defined in the KVXConfigInfo structure. To set custom settings for more than one document type, call the You can also modify element extraction settings by using the
|
KVFLT_INCLREVISIONMARK
|
If you set this flag to To reset the flag and exclude deleted text from the filtered output, set the flag to
|
KVFLT_SETSRCPASSWORD
|
This flag enables you to define a password used to open a password-protected file for filtering. See Filter Password Protected Files.
|
KVFLT_NOEMBEDDEDOBJECT
|
If you set this flag to
|
KVFLT_SHOWHIDDENTEXT
|
If you set this flag to
|
KVFLT_NOCOMMENTS
|
If you set this flag to
|
KVFLT_SKIPEMBEDDEDFONT
|
If you set this flag to
|
KVFLT_SHOWDATEFIELDCODE
|
If you set this flag to
|
KVFLT_SHOWFILENAMEFIELDCODE
|
If you set this flag to
|
KVFLT_KEEPSOFTHYPHEN
|
If you set this flag to
|
KVFLT_EXPORTALLMETADATA
|
If you set this flag to
|
KVFLT_EXPORTTAGGEDCONTENT
|
If you set this flag to
|
KVFLT_SetConfigurableArguments
|
If you set this flag to
|
KVFLT_SETOUTPUTCHARSET
|
This flag enables the output character set to be changed.
|
KVFLT_SHOWHIDDENTEXT
|
If you set this flag to
|
KVFLT_EXTRACTIMAGES
|
If you set this flag to
|
KVFLT_TABDELIMITED
|
If you set this flag to
|
KVFLT_STANDARDIZECELLFORMATS
|
If you set this flag to
|
KVFLT_SOURCECODEDETECTION
|
If you enable this option, KeyView attempts to identify the programming language of any source code files that it finds. The
|
KVFLT_CHARSETDETECTION
|
KeyView attempts to detect the character set of an input file. Some character sets (including ANSI, UTF-8, and UTF-16) can be detected by core KeyView functionality but others can only be detected if your license includes advanced character set detection. If your license includes advanced character set detection, it is enabled by default. However, it can increase the time required to filter some documents. To disable advanced character set detection, set this flag to KeyView cannot perform character set conversion unless it detects the character set of the source file, or you call fpSetSrcCharSet(). For more information see Convert Character Sets. |
To specify a password to open a password-protected file for filtering:
(*fpFilterConfig)(pKVFilter, KVFLT_SETSRCPASSWORD, TRUE, password
);
where password
is a null-terminated string of 255 or fewer characters.
To extract hidden text from Microsoft Word, Excel, or PowerPoint files:
(*fpFilterConfig)(pKVFilter, KVFLT_SHOWHIDDENTEXT, TRUE, NULL);
To extract all custom metadata fields from PDF documents:
(*fpFilterConfig)(pKVFilter, KVFLT_EXPORTALLMETADATA, TRUE, NULL);