AdgKeyTable class | QSYS API Reference Guide
Estimated reading time: 3 minutes
The AdgKeyTable class contains a DataTable object for manipulating key values.
Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll
Inheritance: Object –> AdgTable
Thread Safety
Any public static (Shared) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Constructors
| Name | Description |
|---|---|
| AdgKeyTable(DataTable) | Initializes a new instance of the class with a specified key table template. |
AdgKeyTable(DataTable)
Initializes a new instance of the class with a specified key table template.
AdgKeyTable(DataTable)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| DataTable | keyTableTemplate | The DataTable to be used as a template for the key table. |
Properties
| Type | Name | Description |
|---|---|---|
| DataRowColumnComparer<DataRow> | Comparer | Gets the DataRowColumnComparer used for comparing rows in the key table. |
| Int32 | KeyPartCount | Gets or sets the number of key parts in the key table. |
Methods
| Signature | Description |
|---|---|
| Equals(DataRow) | Determines whether the specified DataRow is equal to the current DataRow. |
bool Equals(DataRow other)
Determines whether the specified DataRow is equal to the current DataRow.
Remarks
This method uses the DataRowColumnComparer associated with this AdgKeyTable instance to compare the specified DataRow with the current DataRow.The DataRowColumnComparer compares the rows based on the first m_cParts columns of the DataTable associated with this AdgKeyTable instance.
bool Equals(DataRow other)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| DataRow | other | The DataRow to compare with the current DataRow. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the specified DataRow is equal to the current DataRow; otherwise, false. |
Example 1. Creating a Key Table to read records by Key. Also uses Row property.
/* This example will open a file and find the record for
the customer "Thilmany of Bread Co Resources".
It omits error trapping for clarity's sake. */
AdgConnection db = new AdgConnection("*Public/DG NET Local");
db.Open();
FileAdapter file = new FileAdapter(db);
file.FileName = "Examples//CMastNewL2";
AdgDataSet dataSet;
file.OpenNewAdgDataSet( out dataSet );
//This next line creates a key based on record format RCMMastL2
AdgKeyTable key = dataSet.NewKeyTable("RCMMastL2");
//We specify KeyPartCount to avoid specifying the second
//key field.
//We then set the keyfield "CMName" to our search argument.
key.KeyPartCount = 1;
key.Row["CMName"] = "Thilmany Of Bread Co Resources";
//The following read will find the record associated with the
//customer name "Thilmany Of Bread Co Resources" and store it
//in dataSet.
file.ReadRandomKey(dataSet, ReadRandomMode.Equal, LockRequest.Default, key);