fpSetExtractionTimeout()
(Out-of-process only) This function specifies the length of time that should elapse before assuming that out-of-process extraction has stopped responding.
Syntax
BOOL pascal fpSetExtractionTimeout( KVFilterSession session, long lTimeout );
Arguments
session
|
A KeyView Filter session that you initialized by calling fpInit(). |
lTimeout
|
The length of time, in seconds, that must elapse before assuming that out-of-process extraction has stopped responding. A negative input is interpreted as an infinite timeout (so the timeout is disabled). |
Returns
-
If the call is successful, the return value is
TRUE
. -
If the call is unsuccessful, the return value is
FALSE
.
Discussion
If this API is not used, KeyView defaults to using the filter timeout duration when fpOpenFile() is called. See fpSetTimeout().
If the out-of-process extraction times out, KeyView shuts down the out-of-process process, which may take some additional time before the function returns.
Example
/* set extraction timeouts to 10 minutes */ if (FALSE == filterInterface->fpSetExtractionTimeout(session, 600)) { /* could not set the extraction timeout */ }