Api.RetrieveKey method

Retrieves the key for the index entry at the current position of a cursor.

Namespace:  Microsoft.Isam.Esent.Interop
Assembly:  Microsoft.Isam.Esent.Interop (in Microsoft.Isam.Esent.Interop.dll)

Syntax

'Declaration
Public Shared Function RetrieveKey ( _
    sesid As JET_SESID, _
    tableid As JET_TABLEID, _
    grbit As RetrieveKeyGrbit _
) As Byte()
'Usage
Dim sesid As JET_SESID
Dim tableid As JET_TABLEID
Dim grbit As RetrieveKeyGrbit
Dim returnValue As Byte()

returnValue = Api.RetrieveKey(sesid, _
    tableid, grbit)

public static byte[] RetrieveKey(
    JET_SESID sesid,
    JET_TABLEID tableid,
    RetrieveKeyGrbit grbit
)

Parameters

• sesid
  Type: Microsoft.Isam.Esent.Interop.JET_SESID

  The session to use.

• tableid
  Type: Microsoft.Isam.Esent.Interop.JET_TABLEID

  The cursor to retrieve the key from.

• grbit
  Type: Microsoft.Isam.Esent.Interop.RetrieveKeyGrbit

  Retrieve key options.

Return value

Type: []
The retrieved key.

See also

Reference

Api class

Api members

Microsoft.Isam.Esent.Interop namespace