AdgDataSet.GetFormatTable Method
Estimated reading time: 2 minutes
Definition
Namespace: ASNA.DataGate.Client
Assembly: ASNA.QSys.DataGate.Client.dll
Retrieves the DataTable associated with the specified format.
Overloads
| Signature | Description |
|---|---|
| GetFormatTable(Int32) | Retrieves the DataTable associated with the specified format index. |
| GetFormatTable(String) | Retrieves the DataTable associated with the specified format name. |
DataTable GetFormatTable(Int32)
Retrieves the DataTable associated with the specified format index.
DataTable GetFormatTable(int iFormat)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Int32 | iFormat | The format index of the DataTable to retrieve. |
Returns
| Type | Description |
|---|---|
| DataTable | The DataTable associated with the specified format index. |
Remarks
GetFormatTable is used to access the underlying DataTable object used to model a DataGate file format in AdgDataSet. It may be used to easily access useful DataTable properties, such as the Rows collection.
GetFormatName provides a way to obtain the format name, given an integer index. The number of formats defined in the AdgDataSet is given by the Formats property. Valid values for iFormat are in the range 0 ≤ _iFormat_ < AdgDataSet.Formats. If iFormat is an invalid index, GetFormatName throws dgException with the Error property set to dgEINVARG.
To use the file format name, use GetFormatTable(string) method.
DataTable GetFormatTable(String)
Retrieves the DataTable associated with the specified format name.
DataTable GetFormatTable(string strFormat)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | strFormat | The format name of the DataTable to retrieve. |
Returns
| Type | Description |
|---|---|
| DataTable | The DataTable associated with the specified format name. |
Remarks
GetFormatTable is used to access the underlying DataTable object used to model a DataGate file format in AdgDataSet. It may be used to easily access useful DataTable properties, such as the Rows collection.
If strFormat is not a valid format name, GetFormatTable throws dgException with the Error property set to dgEINVARG.
To use the file format index, use GetFormatTable(index) method.