KeyView 23.2

# fpOpenDocumentFromStream()

Creates a `KVDocument` from a stream.

The `KVDocument` type is an opaque pointer that represents a single document. You can pass the `KVDocument` into other functions in the Filter API to perform operations with that document.

## Syntax

    KVErrorCode (pascal* fpOpenDocumentFromStream)(
        KVFilterSession session,
        KVInputStream* pInput,
        KVDocument* ppDocument);

## Arguments

`session` | A KeyView Filter session that you initialized by calling fpInit().
`pInput` | A pointer to a KVInputStream. Before calling this function you must create an input stream by using code similar to that in the Filter sample program. For more information, see Filtering in Stream Mode.
`ppDocument` | A pointer to a `KVDocument`.

## Returns

The return value is an error code.

- If the call is successful, the return value is `KVError_Success` and the `KVDocument` is stored in `*ppDocument`.
- If the call is unsuccessful, the return value is an error code and `*ppDocument` is set to NULL.

## Discussion

- After creating a `KVDocument` from a stream, you must not use the input stream for anything else until you have closed the document by calling fpCloseDocument().
- When you no longer need the `KVDocument`, call fpCloseDocument() to free the memory that was allocated by this function.
- The KeyView Filter session must outlive the `KVDocument` created by this function. In other words, you must call fpCloseDocument() on the `KVDocument` before calling fpShutdown() on the Filter session (`session`) that was used to create it.

## Example

The following example demonstrates the creation of a `KVDocument` from a stream.

    KVDocument pDocument = NULL;
    error = fpOpenDocumentFromStream(session, pInput, &pDocument)

Copyright 2016-2023 Open Text
Version 23.2 | Last updated March 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL KeyView 23.2

Topic Title: fpOpenDocumentFromStream()