Class EsentEntityCursor

Inheritance
System.Object
EsentCursor
EsentEntityCursor
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Xbim.IO.Esent
Assembly: Xbim.IO.Esent.dll
Syntax
public class EsentEntityCursor : EsentCursor, IDisposable

Constructors

| Improve this Doc View Source

EsentEntityCursor(EsentModel, String)

Declaration
public EsentEntityCursor(EsentModel model, string database)
Parameters
Type Name Description
EsentModel model
System.String database
| Improve this Doc View Source

EsentEntityCursor(EsentModel, String, OpenDatabaseGrbit)

Constructs a table and opens it

Declaration
public EsentEntityCursor(EsentModel model, string database, OpenDatabaseGrbit mode)
Parameters
Type Name Description
EsentModel model
System.String database
Microsoft.Isam.Esent.Interop.OpenDatabaseGrbit mode

Properties

| Improve this Doc View Source

ColIdEntityData

Declaration
public JET_COLUMNID ColIdEntityData { get; }
Property Value
Type Description
Microsoft.Isam.Esent.Interop.JET_COLUMNID
| Improve this Doc View Source

ColIdEntityLabel

Declaration
public JET_COLUMNID ColIdEntityLabel { get; }
Property Value
Type Description
Microsoft.Isam.Esent.Interop.JET_COLUMNID
| Improve this Doc View Source

ColIdIfcType

Declaration
public JET_COLUMNID ColIdIfcType { get; }
Property Value
Type Description
Microsoft.Isam.Esent.Interop.JET_COLUMNID
| Improve this Doc View Source

ColumnValues

Declaration
public ColumnValue[] ColumnValues { get; }
Property Value
Type Description
Microsoft.Isam.Esent.Interop.ColumnValue[]
| Improve this Doc View Source

PrimaryIndex

Declaration
public string PrimaryIndex { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides
| Improve this Doc View Source

GetIfcType()

Returns the id of the current ifc type

Declaration
public short GetIfcType()
Returns
Type Description
System.Int16
| Improve this Doc View Source

GetLabel()

Returns the current enity label from the curos of the main entity table

Declaration
public int GetLabel()
Returns
Type Description
System.Int32
| Improve this Doc View Source

TryMoveNextEntityType(out XbimInstanceHandle)

For use only on the index table, accesses data from the index only

Declaration
public bool TryMoveNextEntityType(out XbimInstanceHandle ih)
Parameters
Type Name Description
XbimInstanceHandle ih
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TrySeekEntityLabel(Int32)

Returns true if the specified entity label is present in the table, assumes the current index has been set to by primary key (SetPrimaryIndex)

Declaration
public bool TrySeekEntityLabel(int key)
Parameters
Type Name Description
System.Int32 key

The entity label to lookup
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TrySeekEntityType(Int16)

Declaration
public bool TrySeekEntityType(short typeId)
Parameters
Type Name Description
System.Int16 typeId
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TrySeekEntityType(Int16, out XbimInstanceHandle)

Trys to move to the first entity of the specified type, assumes the current index has been set to order by type (SetOrderByType)

Declaration
public bool TrySeekEntityType(short typeId, out XbimInstanceHandle ih)
Parameters
Type Name Description
System.Int16 typeId
XbimInstanceHandle ih
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TrySeekEntityType(Int16, out XbimInstanceHandle, Int32)

Trys to move to the first entity of the specified type, assumes the current index has been set to order by type (SetOrderByType) Secondary keys are specific to the type and defined as IfcAttributes in the class declaration

Declaration
public bool TrySeekEntityType(short typeId, out XbimInstanceHandle ih, int lookupKey)
Parameters
Type Name Description
System.Int16 typeId

the type of entity to look up
XbimInstanceHandle ih
System.Int32 lookupKey

Secondary key on the search
Returns
Type Description
System.Boolean

Returns an instance handle to the first or an empty handle if not found
| Improve this Doc View Source

UpdateCount(Int32)

Update the count of entity in the globals table. This is done with EscrowUpdate so that there won't be any write conflicts.

Declaration
protected override void UpdateCount(int delta)
Parameters
Type Name Description
System.Int32 delta

The delta to apply to the count.
Overrides

Operators

| Improve this Doc View Source

Implicit(EsentEntityCursor to JET_TABLEID)

Declaration
public static implicit operator JET_TABLEID(EsentEntityCursor table)
Parameters
Type Name Description
EsentEntityCursor table
Returns
Type Description
Microsoft.Isam.Esent.Interop.JET_TABLEID

Implements

System.IDisposable