IBDAC

TCustomIBCArray Members

TCustomIBCArray class overview.

Properties

Name Description

ArrayDimensions

Contains the array dimensions count.

ArrayHighBound

Used to get or set the upper boundary of the defined dimension subscript.

ArrayID

Contains the array ID.

ArrayLowBound

Used to get or set the lower boundary of the defined dimension subscript.

ArraySize

Used to determine the size of the whole array data in bytes.

AsString

Used to return array as string.

Cached

Indicates whether to cache array data on the client side.

CachedDimensions

Contains cached array dimensions count.

CachedHighBound

Used to get the upper boundary of defined dimension subscript of cached array elements.

CachedLowBound

Used to get the lower boundary of the defined dimension subscript of cached array elements.

CachedSize

Used to get the cached array data size in bytes.

ColumnName

Used to get or set the name of the table column that has array type.

DbHandle

Contains the handle of a database where the array is stored.

IsNull

Used to define whether the array field in the database is null.

Items

Used to get or set array items.

ItemScale

Used to get or set the scale for array items for the NUMERIC and DECIMAL datatypes.

ItemSize

Contains the size of an array item.

Modified

Used to indicate if the modifications done in cache were saved to the database.

RefCount (inherited from TSharedObject)

Used to return the count of reference to a TSharedObject object.

TableName

Used to set the name of the table containing an array field.

TrHandle

Contains the handle of the transaction in which the array is read or written.

Methods

Name Description

AddRef (inherited from TSharedObject)

Increments the reference count for the number of references dependent on the TSharedObject object.

Assign

Copies the Source object content to the current one.

ClearArray

Clears all array values on the server if Cached is set to False.

CreateTemporaryArray

Creates a temporary array on the InterBase server.

GetArrayInfo

Used to get array descriptor.

GetItemAsDateTime

Reads the value of an array item into an object or variable of the TDateTime type.

GetItemAsFloat

Reads the value of an array item into a floating-point number.

GetItemAsInteger

Reads the value of an array item into a integer.

GetItemAsSmallInt

Reads the value of an array item into a short integer.

GetItemAsString

Reads the value of an array item into a string.

GetItemAsWideString

Reads the value of an array item into a WideString.

GetItemsSlice

Returns the array slice items' values.

GetItemValue

Returns the array item value.

ReadArray

Reads an array from the database to memory.

ReadArrayItem

Reads the array item specified by indices from the database to memory.

ReadArraySlice

Reads array slice from the database to memory.

Release (inherited from TSharedObject)

Decrements the reference count.

SetItemAsDateTime

Assigns the TDateTime value to the contents of an array item.

SetItemAsFloat

Assigns floating-point value to the contents of an array item.

SetItemAsInteger

Assigns integer value to the contents of an array item.

SetItemAsSmallInt

Assigns short integer value to the contents of an array item.

SetItemAsString

Assigns string value to the contents of an array item.

SetItemAsWideString

Assigns WideString value to the contents of an array item.

SetItemsSlice

Sets the array slice values.

SetItemValue

Sets the array item value.

WriteArray

Writes all cached array values to the database.

WriteArraySlice

Writes cached array slice.
© 1997-2022 Devart. All Rights Reserved. Request Support DAC Forum Provide Feedback