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.