Class RecordSetClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[Guid("B517E8C7-6EC0-46E0-80BB-D61ED691C5CE")]
[ClassInterface(ClassInterfaceType.None)]
public class RecordSetClass : RecordSet, IRecordSet2, IRecordSet, IRecordSetInit, IXMLSerialize, IPersistStream, IPersist, IClone
Inheritance
RecordSetClass
Implements
Inherited Members

Constructors

RecordSetClass()

public RecordSetClass()

Explicit Interface Implementations

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

CreateRowBuffer()

Creates a row buffer that can be used with an insert cursor.

virtual IRowBuffer CreateRowBuffer()

Returns

IRowBuffer

Remarks

When using a recordset class, the CreateRowBuffer property is used to create a row buffer that can be used with an insert cursor.

CreateTable(IFields)

Creates an empty table or feature class for a Recordset.

virtual void CreateTable(IFields Fields)

Parameters

Fields IFields

Remarks

When using a recordset class, the CreateTable property is used to create an empty table or feature class for a RecordSet.

Cursor[bool]

A cursor over the rows or features in the recordset.

virtual ICursor Cursor[bool Recycling] { get; }

Parameters

Recycling bool

Returns

ICursor

Remarks

When using a recordset class, the  Cursor property is used to return a cursor over the rows or feature in the RecordSet.

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

DetachTable()

Detach Recordset from table and apply the subfield of QueryFilter.

virtual void DetachTable()

Remarks

When using a record set, the DetachTable property is used to detach a recordset from a table and apply the subfield of a query filter.

Fields

The fields of the recordset.

virtual IFields Fields { get; }

Returns

IFields

Remarks

<P>Each table in a database has an ordered collection of fields, there is always at least one field in a table. The ordered collection behaves like a list, so it is possible to access individual fields by a numbered position (or index) in the list.</P> <P>A <STRONG>Fields </STRONG>collection can also exist independently of a table, for example when creating an index on a table you will need to define which fields take part in the index. There are many interfaces which either require or return a <STRONG>Fields </STRONG>collection; these include <STRONG>IClass </STRONG>(therefore also <STRONG>IObjectClass </STRONG>and <STRONG>IFeatureClass</STRONG>), <STRONG>ICursor</STRONG>, <STRONG>IIndex</STRONG>, <STRONG>IFeatureClassDraw</STRONG>, <STRONG>IRowBuffer</STRONG>, <STRONG>ISimpleDataConverter</STRONG>, <STRONG>ITableSort </STRONG>and <STRONG>IValidate</STRONG>.</P>

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IPersistStream_GetClassID(out Guid)

virtual void IPersistStream_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

IRecordSet2_Cursor[bool]

virtual ICursor IRecordSet2_Cursor[bool Recycling] { get; }

Parameters

Recycling bool

Returns

ICursor

IRecordSet2_Fields

virtual IFields IRecordSet2_Fields { get; }

Returns

IFields

IRecordSet2_IsFeatureCollection

virtual bool IRecordSet2_IsFeatureCollection { get; }

Returns

bool

IRecordSet2_Table

virtual ITable IRecordSet2_Table { get; }

Returns

ITable

Insert()

Returns a cursor that can be used to insert new rows.

virtual ICursor Insert()

Returns

ICursor

Remarks

When using a recordset class, the Insert property is used to return a cursor that can be used to insert new rows into a RecordSet.

IsDirty()

virtual void IsDirty()

IsEqual(IClone)

Indicates if the receiver and other have the same properties.

virtual bool IsEqual(IClone other)

Parameters

other IClone

Returns

bool

IsFeatureCollection

Indicates if the recordset is a feature collection.

virtual bool IsFeatureCollection { get; }

Returns

bool

Remarks

When using a recordset class, the IsFeatureCollection property is used to return true and is read only if the RecordSet is a feature collection.

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

MaxRecordCount

The maximum number of records for the recordset.

virtual int MaxRecordCount { get; set; }

Returns

int

Remarks

When using a recordset class, the MaxRecordCount property is used to return the maximum number of records for the recordset.

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

SaveAsTable(IWorkspace, string)

Saves the recordset to a table of feature class in the provided workspace.

virtual ITable SaveAsTable(IWorkspace Workspace, string TableName)

Parameters

Workspace IWorkspace
TableName string

Returns

ITable

Remarks

SaveAsTable will save the recordset into the specified table or feature class in the provided workspace.  SaveAsTable supports Personal, File and ArcSDE geodatabases as well as shapefile workspaces.

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

SetSourceQueryDef(IQueryDef)

Sets the source QueryDef for a Recordset.

virtual void SetSourceQueryDef(IQueryDef QueryDef)

Parameters

QueryDef IQueryDef

Remarks

When using a recordset class, the SetSourceQueryDef property is used to sets the source QueryDef for a Recordset.

SetSourceTable(ITable, IQueryFilter)

Sets the source table or feature class for a Recordset.

virtual void SetSourceTable(ITable Table, IQueryFilter QueryFilter)

Parameters

Table ITable
QueryFilter IQueryFilter

Remarks

When using a recordset class, the SetSourceTable property is used to set the source table or feature class for a Recordset.

Table

The source table or feature class for the recordset.

virtual ITable Table { get; }

Returns

ITable

Remarks

<P>A <STRONG>Table </STRONG>object has one or more columns, referred to as fields, and contains an unordered collection of rows. Each row has for each field exactly one value in the data type of the field.</P> <P>A <STRONG>Table </STRONG>is a <STRONG>Dataset </STRONG>and properties such as the name of the table, the persistable name object for the table, and the workspace containing the table, may be obtained via the <STRONG>IDataset </STRONG>interface. In relational terms, a <STRONG>Table </STRONG>object represents an RDBMS table or view. In objected-oriented terms, a Table object represents an ObjectClass or a RelationshipClass in a geodatabase. A <STRONG>Table </STRONG>object hands out <STRONG>Row </STRONG>objects which themselves support application callable methods depending on the type of data stored in the table.</P> <P>The <STRONG>Name </STRONG>property of a <STRONG>Table</STRONG>, accessible via the <STRONG>IDataset </STRONG>interface, returns its fully qualified name. The level of qualification may vary depending on the host DBMS. For example, a table named ‘pipes’, owned by a user named ‘gas’ may be called ‘pipes’ in and Access or File Geodatabase, ‘gas.pipes’ on Oracle and ‘mydb.gas.pipes’ on SQLServer. The <STRONG>ParseTableNamemethod </STRONG>on the <STRONG>ISqlSyntax </STRONG>interface supported by the table’s workspace can be used to split the fully qualified name into its components.</P>