fpSetTimeout()

(Out-of-process only) This function specifies the length of time that should elapse before assuming that the filtering process has stopped responding.

Syntax

BOOL pascal fpSetTimeout( KVFilterSession session, long lTimeout );

Arguments

session

A Filter session that you initialized by calling fpInit().

lTimeout

The length of time that must elapse before assuming that the filtering process has stopped responding.

By default this value is in seconds. You can change this unit to milliseconds by setting KvoopTimeOutUnit=millisecond in the [FilterSDK_Config] section of the formats.ini file.

Discussion

The default timeout is six minutes.

File Content Extraction shuts down the out-of-process process when the timeout is reached. The next operation you perform on the session might take longer than usual because a new out-of-process process is set up to service the request.

Returns

  • If the call is successful, the return value is TRUE.
  • If the call is unsuccessful, the return value is FALSE.