fpGetOLESummaryInfoFile()

This function extracts document metadata from a file.

DEPRECATED: The fpGetOLESummaryInfoFile() 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 fpGetOLESummaryInfoFile(
    KVFilterSession     session, 
    char               *szFile,
    KVSummaryInfoEx    *pSummaryInfo);

Arguments

session

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

szFile The name of the input file.
pSummaryInfo A pointer to the KVSummaryInfoEx structure. 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 KVSumInfoElemEx structure.

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.
  • This function runs in process or out of process. See The Filter Process Model.
  • On Windows, szFile must be in the local Windows code page.