beautypg.com

Pcdputstream, The supplied, Object – Kofax DM API User Manual

Page 122: Objec

background image

102 C

HAPTER

3

PCDPutStream

PCDPutStream

Use PCDPutStream to provide users with the ability to write the
contents of physical files to disk.

Syntax

PCDPutStream.

methodOrProperty

Usage

After each write, you should check the

ErrNumber

property, which

should be zero (S_OK). If your write was error-free, you should check
the

BytesWritten

property to see how many bytes were actually written

to the physical file.

Note: If you are using a language other than JavaScript, you can use the
optional second parameter for

Write

to get the number of bytes written. This

allows you to avoid having to use the BytesWritten property to retrieve this
information.

Example

Because of the close relationship that PCDPutStream has with

PCDPutDoc

, the

Example

in PCDPutDoc also illustrates how you can

use PCDPutStream.

Related Items

See the following methods:

GetPropertyValue
SetComplete
Write

See the following properties:

BytesWritten
ErrDescription

ErrNumber