beautypg.com

Bytesread, Gd.bytesread, M.bytesread – Kofax DM API User Manual

Page 173

background image

DM API M

ETHODS

AND

P

ROPERTIES

153

BytesRead

BytesRead

This property is always set during a

Read

operation. It contains the

number of bytes returned by the call to the

Read

method.

Syntax

PCDGetStream.BytesRead()

Returns

Returns the number of bytes read during a

Read

operation. Languages

such as JavaScript, Visual Basic, and VBScript return this as a function
value.

Example

The section titled

Fetching a DM Document Object

in Chapter 1

illustrates how to use this method.

Related Items

See the

PCDGetStream

object.

See the following methods:

GetPropertyValue

Read

Seek

See the following properties:

ErrDescription

ErrNumber