Read, Read(1, M.read(51 – Kofax DM API User Manual

Page 274: Ng a

Advertising
background image

254 C

HAPTER

4

Read

Read

Use this method to read binary data from a physical file.

Syntax

PCDGetStream.Read( lngBytes, [ lngBytesRead ] )

Parameters

Returns

Returns a

VARIANT

containing a

SAFEARRAY

of bytes that is the actual

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

Usage

Some programming languages, such as C++ and Visual Basic, support
the optional second parameter for this method. In programming
languages that do not support it, you can follow the Read method with
the

BytesRead

method to obtain the number of bytes read.

Related Items

See the

PCDGetStream

object.

See the following methods:

GetPropertyValue
Seek

See the following properties:

BytesRead
ErrDescription
ErrNumber

lngBytes

An unsigned long integer that contains the number
of bytes to attempt to read.

lngBytesRead

An unsigned long set to the number of bytes read
during the call. This parameter is optional.

Advertising