fpGetOLESummaryInfo()

This function extracts document metadata from an input stream.

DEPRECATED: The fpGetOLESummaryInfo() function is deprecated in KeyView 23.2.0 and later. OpenText recommends that you create a KVDocument to represent each document, and access metadata by calling the function fpGetMetadataList().

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

Syntax

KVErrorCode pascal fpGetOLESummaryInfo( 
    KVFilterSession     session,
    KVInputStream      *pInput,
    KVSummaryInfoEx    *pSummaryInfo );

Arguments

session

A KeyView Filter session that you initialized by calling fpInit().

pInput A pointer to the developer-assigned instance of KVInputStream. The structure KVInputStream defines the input stream that contains the source.
pSummaryInfo A pointer to the structure KVSummaryInfoEx. In the structure, nElem provides a count of the number of metadata elements, and pElem points to the first element of the array of individual elements as defined by the structure KVSumInfoElemEx.

Returns

The return value is an error code. See KVErrorCode.

Discussion

  • After the pSummaryInfo argument is successfully filled, and its data is no longer required, call fpFreeOLESummaryInfo() to free the memory allocated by this function.