# fpFilterStream()

This function filters text from an input stream to an output buffer.

## Syntax

    KVErrorCode pascal fpFilterStream(
        void            *pContext,
        void            *pStreamContext
        KVFilterOutput  *pFilterOutput,
        KVSummaryInfoEx *pSummaryInfo);

## Arguments

`pContext` | A pointer returned from fpInit() or fpInitWithLicenseData().
`pStreamContext` | A pointer returned from fpOpenStream() or fpOpenStreamEx2().
`pFilterOutput` | A pointer to the KVFilterOutput structure. This structure defines the output buffer.
`pSummaryInfo` | This argument is reserved. It must be `NULL`.

## Returns

The return value is an error code. See KVErrorCode.

## Discussion

- This function processes data in chunks. To return the entire output stream, you must call this function repeatedly until the entire output buffer is processed, that is, until the following condition occurs:

      pFilterOutput-> cbText == 0

- This function runs in process or out of process. See The Filter Process Model.
- After each call to `fpFilterStream`, once the data in the `pFilterOutput` argument is no longer required, call fpFreeFilterOutput to free the memory allocated by this function.

## Example

    error = (int)(*pFilterInterface->fpFilterStream)( pFilter, pStream, &filterOut, NULL );

© Copyright 2016-2020 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a mail client, and then send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm