Interface IMutableProcedureRecordSet

A IProcedureRecordSet whose contents can be modified.

Inherited Members

IProcedureRecordSet.GetProcedureRecord(int)

IRecordSet.Count

IRecordSet.ColumnNames

IRecordSet.GetRecord(int)

IRecordSet.ToXMLString()

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IMutableProcedureRecordSet : IProcedureRecordSet, IRecordSet

Remarks

A IProcedureRecordSet whose contents can be modified. Records can be changed, added, removed and sorted.

Methods

AddRecord()

Adds a new record to the end of the recordset.

Declaration

IMutableProcedureRecord AddRecord()

Returns

Type	Description
IMutableProcedureRecord	the new record

AddRecord(IRecord)

Adds a copy of an existing record.

Declaration

IMutableProcedureRecord AddRecord(IRecord record)

Parameters

Type	Name	Description
IRecord	record	the existing record

Returns

Type	Description
IMutableProcedureRecord	the added record

Remarks

Adds a copy of an existing record. If the columns in this record set do not exactly match the columns in the specified record, mapping is done via column names. The value of any column in this record set that does not have a corresponding column in the specified record is set to null.

AddRecord(IRecord, IDictionary<string, string>)

Adds a copy of an existing record.

Declaration

IMutableProcedureRecord AddRecord(IRecord record, IDictionary<string, string> mapping)

Parameters

Type	Name	Description
IRecord	record	the existing record
IDictionary<string, string>	mapping	a map of column names in the specified record to column names in this record set

Returns

Type	Description
IMutableProcedureRecord	the added record

Remarks

Adds a copy of an existing record. The specified map is used to map from column names in the specified record to column names in this record set. The value of any column in this record set that does not have a corresponding column in the map is set to null.

AddRecord(int)

Inserts a new record at the specified row.

Declaration

IMutableProcedureRecord AddRecord(int row)

Parameters

Type	Name	Description
int	row	the row number at which to insert the new record

Returns

Type	Description
IMutableProcedureRecord	the new record

AddRecord(int, IRecord)

Inserts a copy of an existing record at the specified row.

Declaration

IMutableProcedureRecord AddRecord(int row, IRecord record)

Parameters

Type	Name	Description
int	row	the row number at which to insert the new record
IRecord	record	the existing record

Returns

Type	Description
IMutableProcedureRecord	the added record

Remarks

Inserts a copy of an existing record at the specified row. If the columns in this record set do not exactly match the columns in the specified record, mapping is done via column names. The value of any column in this record set that does not have a corresponding column in the specified record is set to null.

AddRecord(int, IRecord, IDictionary<string, string>)

Inserts a copy of an existing record at the specified row.

Declaration

IMutableProcedureRecord AddRecord(int row, IRecord record, IDictionary<string, string> mapping)

Parameters

Type	Name	Description
int	row	the row number at which to insert the new record
IRecord	record	the existing record
IDictionary<string, string>	mapping	a map of column names in the specified record to column names in this record set

Returns

Type	Description
IMutableProcedureRecord	the added record

Remarks

Inserts a copy of an existing record at the specified row. The specified map is used to map from column names in the specified record to column names in this record set. The value of any column in this record set that does not have a corresponding column in the map is set to null.

AddRecords(IRecordSet)

Adds a copy of all records in the specified record set.

Declaration

void AddRecords(IRecordSet recordset)

Parameters

Type	Name	Description
IRecordSet	recordset	the recordset from which to copy the records

Remarks

Adds a copy of all records in the specified record set. See AddRecords(IRecordSet, IDictionary<string, string>) for details on how each record is processed.

AddRecords(IRecordSet, IDictionary<string, string>)

Adds a copy of all records in the specified record set.

Declaration

void AddRecords(IRecordSet recordset, IDictionary<string, string> mapping)

Parameters

Type	Name	Description
IRecordSet	recordset	the recordset from which to copy the records
IDictionary<string, string>	mapping	a map of column names in the specified record to column names in this record set

Remarks

Adds a copy of all records in the specified record set. See AddRecord(int, IRecord, IDictionary<string, string>) for details on how each record is processed.

AddRecords(int, IRecordSet)

Inserts a copy of all records in the specified record set at the specified row.

Declaration

void AddRecords(int row, IRecordSet recordset)

Parameters

Type	Name	Description
int	row	the row number at which to insert the new records
IRecordSet	recordset	the recordset from which to copy the records

Remarks

Inserts a copy of all records in the specified record set at the specified row. See AddRecord(int, IRecord, IDictionary<string, string>) for details on how each record is processed.

AddRecords(int, IRecordSet, IDictionary<string, string>)

Inserts a copy of all records in the specified record set at the specified row.

Declaration

void AddRecords(int row, IRecordSet recordset, IDictionary<string, string> mapping)

Parameters

Type	Name	Description
int	row	the row number at which to insert the new records
IRecordSet	recordset	the recordset from which to copy the records
IDictionary<string, string>	mapping	a map of column names in the specified record to column names in this record set

Remarks

Inserts a copy of all records in the specified record set at the specified row. See AddRecord(int, IRecord, IDictionary<string, string>) for details on how each record is processed.

GetMutableProcedureRecord(int)

Gets a record by row number.

Declaration

IMutableProcedureRecord GetMutableProcedureRecord(int row)

Parameters

Type	Name	Description
int	row	the zero-based row number

Returns

Type	Description
IMutableProcedureRecord	the record for the specified row ApptrieveException if the row index is invalid

Remarks

Gets a record by row number. This is equivalent to calling GetRecord(int) except that no cast is required to obtain the IMutableProcedureRecord interface.

RemoveRecord(IProcedureRecord)

Removes the specified record from the record set.

Declaration

void RemoveRecord(IProcedureRecord record)

Parameters

Type	Name	Description
IProcedureRecord	record	the record to remove ApptrieveException if the record is not found

RemoveRecord(int)

Removes the record at the specified row.

Declaration

void RemoveRecord(int row)

Parameters

Type	Name	Description
int	row	the row number of the record to remove ApptrieveException if the row index is invalid

SortRecords(IComparer<IRecord>)

Sorts the records using a IComparer<T>.

Declaration

void SortRecords(IComparer<IRecord> comparator)

Parameters

Type	Name	Description
IComparer<IRecord>	comparator	the comparator to use to compare rows

SortRecords(int)

Sort the records based on a column.

Declaration

void SortRecords(int column)

Parameters

Type	Name	Description
int	column	the index of the column to sort by

SortRecords(int[])

Sort the records based multiple columns.

Declaration

void SortRecords(int[] columns)

Parameters

Type	Name	Description
int[]	columns	an array of column indices to sort by