KeyView 24.2

# fpGetExtractStatus()

This function returns the status of an input stream opened by fpOpenSubFile().

## Syntax

    int (pascal *fpGetExtractStatus) (
           KVInputStream *stream);

## Arguments

`stream` | The pointer to the KVInputStream structure returned by fpOpenSubFile().

## Returns

If an error occurred when one of the input stream function pointers was last called, this function should return the associated KeyView error code. If no problem was encountered, `KVERR_Success` should be returned.

In exceptional circumstances, a problem may occur when obtaining the status of the stream and, in this case, the error code will reflect this issue instead. For example, if `stream` is `NULL`, `KVError_InvalidArgs` is returned.

## Discussion

The status of a KVInputStream is set when a call is made to one of the KVInputStream function pointers and so this method can be called to establish the cause of any stream function failing. Possible problems include the container holding the subfile having an invalid format and invalid arguments being passed to the stream function pointer.

Copyright 1997-2024 Open Text
Version 24.2 | Last updated March 2024

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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.2

Topic Title: fpGetExtractStatus()