About  Usage  ADOxtra  Common  Connection  Recordset  Field  Property

ADOxtra Field object properties:

Data accessing properties:
Value,
OriginalValue,
UnderlyingValue
 
Field information properties:
Name,
ActualSize,
DefinedSize,
NumericScale,
Precision,
Type
Attributes

Field.Value

Syntax

put Field.Value
Field.Value=1

Sets or gets

Any
Value property of the field object.

Description

Sets or gets the Value property of the wrapped ADODB.Field object. Use the Value property to set or return data from Field objects.

Version

Set operations are not supported in the Lite version

Field.OriginalValue

Syntax

put Field.OriginalValue

Returns

Any
OriginalValue property of the field object.

Description

Returns the OriginalValue property of the wrapped ADODB.Field object. Use the OriginalValue property to return the original field value for a field from the current record.

Field.UnderlyingValue

Syntax

put Field.UnderlyingValue

Returns

Any
UnderlyingValue property of the field object.

Description

Returns the UnderlyingValue property of the wrapped ADODB.Field object. Use the UnderlyingValue property to return the current field value from the database. The field value in the UnderlyingValue property is the value that is visible to your transaction and may be the result of a recent update by another transaction. This may differ from the OriginalValue property, which reflects the value that was originally returned to the Recordset.

Field.Name

Syntax

put Field.Name

Returnss

String
value that indicates the name of the Field object.

Description

Returns the Name property of the wrapped ADODB.Field object. Use the Name property to retrieve the name of a field object.

Field.ActualSize

Syntax

put Field.ActualSize

Returns

Integer
value that indicates the actual length of a field's value.

Description

Returns the ActualSize property of the wrapped ADODB.Field object. Use the ActualSize property to return the actual length of a Field object's value. If ADO cannot determine the length of the Field object's value, the ActualSize property returns -1.

Field.DefinedSize

Syntax

put Field.DefinedSize

Returns

Integer
value that reflects the defined size of a field as a number of bytes.

Description

Returns the DefinedSize property of the wrapped ADODB.Field object. Use the DefinedSize property to determine the data capacity of a Field object.

Field.NumericScale

Syntax

put Field.NumericScale

Returns

Integer
value that indicates the number of decimal places to which numeric values will be resolved.

Description

Returns the NumericScale property of the wrapped ADODB.Field object. Use the NumericScale property to determine how many digits to the right of the decimal point is used to represent values for a numeric Field object..

Field.Precision

Syntax

put Field.Precision

Returns

Integer
value that indicates the maximum number of digits used to represent values.

Description

Returns the Precision property of the wrapped ADODB.Field object. Use the Precision property to get the maximum number of digits used to represent values for a numeric Field object.

Field.Type

Syntax

put Field.Type

Returns

Integer
value that indicates the data type of a Field object.

Description

Returns the Type property of the wrapped ADODB.Field object. Refer to ADO documentation for a list of possible values. Here is a subset of values that may be usefull in Lingo:
Constant Value Description
adBoolean 11 Indicates a boolean value.
adBSTR 8 Indicates a null-terminated character string (Unicode).
adChar 129 Indicates a string value.
adCurrency 6 Indicates a currency value. Currency is a fixed-point number with four digits to the right of the decimal point. It is stored in an eight-byte signed integer scaled by 10,000.
adDate 7 Indicates a date value. A date is stored as a double, the whole part of which is the number of days since December 30, 1899, and the fractional part of which is the fraction of a day.
adDecimal 14 Indicates an exact numeric value with a fixed precision and scale.
adDouble 5 Indicates a double-precision floating-point value.
adEmpty 0 Specifies no value.
adInteger 3 Indicates a four-byte signed integer.
adGUID 72 Indicates a globally unique identifier (GUID).
adLongVarWChar 203 Indicates a long null-terminated Unicode string value.
adNumeric 131 Indicates an exact numeric value with a fixed precision and scale.
adSingle 4 Indicates a single-precision floating-point value.
adSmallInt 2 Indicates a two-byte signed integer.
adTinyInt 16 Indicates a one-byte signed integer.
adUnsignedInt 19 Indicates a four-byte unsigned integer.
adUnsignedSmallInt 18 Indicates a two-byte unsigned integer.
adUnsignedTinyInt 17 Indicates a one-byte unsigned integer.
adUserDefined 132 Indicates a user-defined variable.
adVarBinary 204 Indicates a binary value.
adVarChar 200 Indicates a string value.
adVarNumeric 139 Indicates a numeric value.
adVarWChar 202 Indicates a null-terminated Unicode character string.
adWChar 130 Indicates a null-terminated Unicode character string.

Field.Attributes

Syntax

put Field.Attributes

Returns

Integer
value that indicates characteristics of a Property object. It can be a bitmask of the following values:
Constant Value Description
adFldCacheDeferred 0x1000 Indicates that the provider caches field values and that subsequent reads are done from the cache.
adFldFixed 0x10 Indicates that the field contains fixed-length data.
adFldIsChapter 0x2000 Indicates that the field contains a chapter value, which specifies a specific child recordset related to this parent field. Typically chapter fields are used with data shaping or filters.
adFldIsCollection 0x40000 Indicates that the field specifies that the resource represented by the record is a collection of other resources, such as a folder, rather than a simple resource, such as a text file.
adFldIsDefaultStream 0x20000 Indicates that the field contains the default stream for the resource represented by the record. For example, the default stream can be the HTML content of a root folder on a Web site, which is automatically served when the root URL is specified.
adFldIsNullable 0x20 Indicates that the field accepts null values.
adFldIsRowURL 0x10000 Indicates that the field contains the URL that names the resource from the data store represented by the record.
adFldLong 0x80 Indicates that the field is a long binary field. Also indicates that you can use the AppendChunk and GetChunk methods.
adFldMayBeNull 0x40 Indicates that you can read null values from the field.
adFldMayDefer 0x2 Indicates that the field is deferred—that is, the field values are not retrieved from the data source with the whole record, but only when you explicitly access them.
adFldNegativeScale 0x4000 Indicates that the field represents a numeric value from a column that supports negative scale values. The scale is specified by the NumericScale property.
adFldRowID 0x100 Indicates that the field contains a persistent row identifier that cannot be written to and has no meaningful value except to identify the row (such as a record number, unique identifier, and so forth).
adFldRowVersion 0x200 Indicates that the field contains some kind of time or date stamp used to track updates.
adFldUnknownUpdatable 0x8 Indicates that the provider cannot determine if you can write to the field.
adFldUnspecified -1
0xFFFFFFFF
Indicates that the provider does not specify the field attributes.
adFldUpdatable 0x4 Indicates that you can write to the field.

Description

Returns the Attributes property of the wrapped ADODB.Field object. Use the Attributes property to return characteristics of Field object

©2001 Eugene Shoustrov www.adoxtra.com Built on March 28, 2001