AppRecord ReadByColumn() Method

Reads any record type by a column value.

Function Signature

 bool ReadByColumn( columnName, value )

Parameters

Parameter	Type	Description
columnName	string	The database name of the column without the TS_ prefix.
value	Variant	Behavior depends on the Variant internal type: string – ReadByColumn() will succeed if the column is a text column. int, int64_t, short, byte, or bool – ReadByColumn() will succeed if the column is an integer column. float or double – ReadByColumn() will succeed if the column is a floating point column.

Parameter

Type

Description

columnName

string

The database name of the column without the TS_ prefix.

value

Variant

Behavior depends on the Variant internal type:

string – ReadByColumn() will succeed if the column is a text column.
int, int64_t, short, byte, or bool – ReadByColumn() will succeed if the column is an integer column.
float or double – ReadByColumn() will succeed if the column is a floating point column.

Return

Type	Description
bool	Returns true if the item is read successfully; false if the item is not found.

Technical Details

SBM ModScript version: 11.3.

Example

var tableId = Ext.TableId( "TS_USERS" );
var record = Ext.CreateAppRecord( tableId );
if( record.ReadByColumn( "LOGINID", "joe" )){
    var name = record.GetName();
    Ext.WriteStream( "User is " + name  );
}

Notes

As the behavior depends on the Variant internal type, the functions CInt, CStr, and CDbl can be used to get a Variant with the desired internal type.

If the table is cached by Application Engine, the record may be read from the cache instead of the database.