Num_components – Kofax DM API User Manual

Page 429

Advertising
background image

DM API T

OKENS

409

%NUM_COMPONENTS

%NUM_COMPONENTS

Where the document is comprised of multiple files (for example, as is
the case with some CAD/CAM engineering software), use this token to
get the number of components that comprise the current document.
For documents that are not comprised of multiple files, the

%NUM_COMPONENTS

token returns the number of properties returned

in the search result set. (This same value is returned by use of the

GetRowsFound

method.)

Syntax

PCDGetDoc.GetPropertyValue(“%NUM_COMPONENTS”)

Parameters

Usage

The value that

%NUM_COMPONENTS

returns is only available after the

search is executed until the

SetRow

or

NextRow

methods are called.

Example

See the

%CONTENTS

example on page 306

.

Related Items

See the

PCDGetDoc

object.

See the

GetPropertyValue

method.

%NUM_COMPONENTS

The token identifier that returns either
the number of components (for a multi-
file document) or the number of rows in
the search result data set.

Advertising