GetSummaryInfo

Description

Gets the document metadata, also referred to as summary information. See Extract Document Metadata.

Syntax

bRet = KeyView.GetSummaryInfo(nItem, nTotalItem, nValid, nType, lVal, szVal, szUserVal)

Parameters

Parameter

Type

Description

nItem

Integer

The summary information item number.

nTotalItem

Integer

The total number of summary information items available in the source document.

nValid

Integer

Specifies whether the data value is present in the document.

0 – The summary information field is not available.

1 – The summary information field is available.

nType

Integer

The data type of the metadata element.

1szVal contains the field contents.

2lVal contains the field contents.

The types are defined in KVSumInfoType in kvtypes.h.

lVal

Integer

Contains the contents of the summary information field if the contents are numeric.

szVal

String

Contains the contents of the summary information field if the contents are non-numeric.

szUserVal

String

The summary information field name.

Returns

Type

Description

Boolean

TRUE if the method succeeds.

FALSE if the method fails.


_HP_HTML5_bannerTitle.htm