Interface IRecordSetContext
Stores state information for a recordset and its records.
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IRecordSetContextRemarks
Stores state information for a recordset and its records. The state is automatically cleared when a fetch completes.
Properties
EntityName
Gets the entity name.
Declaration
string EntityName { get; }Property Value
| Type | Description |
|---|---|
| string | the name of the entity |
RecordSetName
Gets the record set name.
Declaration
string RecordSetName { get; }Property Value
| Type | Description |
|---|---|
| string | the name of the record set |
Methods
GetRecordSetStateObject(string)
Gets the recordset context object bound to the specified name, or null if no object is bound.
Declaration
object GetRecordSetStateObject(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | the name of the object |
Returns
| Type | Description |
|---|---|
| object | the object bound to the specified name or null if none |
GetRecordStateObject(int, string)
Gets the object bound to the specified name in the record context, or null if no object is bound to the name.
Declaration
object GetRecordStateObject(int record, string name)Parameters
| Type | Name | Description |
|---|---|---|
| int | record | record index of the record |
| string | name | the name of the object |
Returns
| Type | Description |
|---|---|
| object | the object bound to the specified name or null if none |
IsRecordSetStateObject(string)
Tests for the presence of a recordset context object bound to the specified name.
Declaration
bool IsRecordSetStateObject(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | the name of the object |
Returns
| Type | Description |
|---|---|
| bool | true if an object is bound to the specified name |
IsRecordStateObject(int, string)
Tests for the presence of a record context object bound to the specified name.
Declaration
bool IsRecordStateObject(int record, string name)Parameters
| Type | Name | Description |
|---|---|---|
| int | record | index of the record |
| string | name | the name of the object |
Returns
| Type | Description |
|---|---|
| bool | true if an object is bound to the specified name |
SetRecordSetStateObject(string, object)
Binds an object to this record set context, using the name specified.
Declaration
void SetRecordSetStateObject(string name, object obj)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | the name of the object |
| object | obj | the object to bind |
Remarks
Binds an object to this record set context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.
SetRecordStateObject(int, string, object)
Binds an object to this record context, using the name specified.
Declaration
void SetRecordStateObject(int record, string name, object obj)Parameters
| Type | Name | Description |
|---|---|---|
| int | record | index of the record |
| string | name | the name to which to bind the object |
| object | obj | the object to bind |
Remarks
Binds an object to this record context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.