fpOpenStreamEx2()
This function opens a stream for filtering and enables you to set bitwise flags for each stream.
DEPRECATED: The fpOpenStreamEx2()
function is deprecated in KeyView 23.2.0 and later. OpenText recommends that you create a KVDocument
to represent each document, by calling fpOpenDocumentFromStream().
You only need to call fpOpenStreamEx2()
if you want to use deprecated functions, such as fpCanFilterStream() and fpFilterStream(), that require a stream context.
This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.
Syntax
void * pascal fpOpenStreamEx2( KVFiltersession session, KVInputStream *pInput, DWORD dwFlags);
Arguments
session
|
A KeyView Filter session that you initialized by calling fpInit(). |
pInput
|
A pointer to the developer-assigned instance of KVInputStream. The KVInputStream structure defines the input stream that contains the source. |
dwFlags
|
Instructions on how to process a stream. See Flags for dwFlags. |
Returns
- If the call is successful, the return value is a
void *
pointer passed to fpFilterStream(), fpCanFilterStream(), and fpCloseStream(). - If the call is unsuccessful, the return value is
NULL
.
Discussion
- Before you call this function, you must create an input stream either by using the fpFileToInputStreamCreate() function, or by using code similar to the coding example in the Filter sample program. For more information, refer to the KeyView Filter Tutorial on Github.
- After filtering is complete, call fpCloseStream() to free the memory allocated by this function.