fpCloseStream()
This function closes a document stream opened by using fpOpenStream()
.
DEPRECATED: The fpCloseStream()
function is deprecated in KeyView 23.2.0 and later.
OpenText recommends that instead of calling fpOpenStream() or fpOpenStreamEx2(), you create a KVDocument
to represent each document, by calling fpOpenDocumentFromStream(). When you no longer need a KVDocument
, call fpCloseDocument().
This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.
Syntax
BOOL pascal fpCloseStream( KVFilterSession session, void *pStreamContext );
Arguments
session
|
A KeyView Filter session that you initialized by calling fpInit(). |
pStreamContext
|
A pointer returned from fpOpenStream() or fpOpenStreamEx2(). |
Returns
- If the call is successful, the return value is
TRUE
. - If the call is unsuccessful, the return value is
FALSE
.
Discussion
After filtering is complete, call this function to free the memory allocated by fpOpenStream()
or fpOpenStreamEx2()
.