fpGetExtractInfo()

DEPRECATED: The fpGetExtractInfo() function is deprecated in File Content Extraction version 26.2 and later. This function relates to the deprecated fpOpenSubFile() function. OpenText recommends that you use fpOpenDocumentFromSubFile() or fpOpenFile() instead.

This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.

This function returns information about a stream opened by fpOpenSubFile().

Syntax

int (pascal *fpGetExtractInfo) (
       KVInputStream *stream,
       KVSubFileExtractInfo *extractInfo);

Arguments

`stream`	The pointer to the `KVInputStream` structure returned by fpOpenSubFile().
`extractInfo`	On success, this KVSubFileExtractInfo points to a newly allocated structure, which provides information about the extracted subfile.

Returns

If an issue occurs when obtaining the extraction information, the return value is an error code. Otherwise, the return value is KVERR_Success.

Lifetime and Memory Management

You must call fpFreeStruct() to free the memory allocated for extractInfo. Call fpFreeStruct() only when fpGetExtractInfo() returns KVError_Success. You must free this memory before you call fpCloseSubFile().