brRead Method

       

Reads an item from the D3 file associated with the clsD3File object, returning a clsD3DynamicArray object.

Syntax

Set oDynArray = object.brRead(sItemName, [vColumn], [bLocking])

Parameters

Parameter

Description

odynArray

An object variable that represents a clsD3DynamicArray object containing the data read from the D3 file.

object

An object variable that represents a clsD3File object.

sItemName

A String specifying the item-id of the item to read.

vColumn

Optional and not recommended. Provided only for legacy applications. A Variant specifying either the attribute-defining item or the attribute number to be returned. If not specified or -1, then the entire item is returned.

NOTE: To read a specific attribute from an item in a D3 file, we recommend using the brReadV or brReadVU method.

bLocking

Optional and not recommended. Provided only for legacy applications. A constant indicating whether the item is locked during the read, as specified in Settings. The default is d3Item_ReadNoLock indicating no locking.

NOTE: To read an item from the D3 file with locking, we recommend using the brReadV method.

Remarks

If no data is found referenced by sItemName, this method raises the exception d3SrvErr_Access.

FlashBASIC Reference

read