Api.JetRetrieveKey method

Retrieves the key for the index entry at the current position of a cursor. Also see RetrieveKey(JET_SESID, JET_TABLEID, RetrieveKeyGrbit).

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

Syntax

'Declaration
Public Shared Sub JetRetrieveKey ( _
    sesid As JET_SESID, _
    tableid As JET_TABLEID, _
    data As Byte(), _
    dataSize As Integer, _
    <OutAttribute> ByRef actualDataSize As Integer, _
    grbit As RetrieveKeyGrbit _
)
'Usage
Dim sesid As JET_SESID
Dim tableid As JET_TABLEID
Dim data As Byte()
Dim dataSize As Integer
Dim actualDataSize As Integer
Dim grbit As RetrieveKeyGrbitApi.JetRetrieveKey(sesid, tableid, _
    data, dataSize, actualDataSize, grbit)

public static void JetRetrieveKey(
    JET_SESID sesid,
    JET_TABLEID tableid,
    byte[] data,
    int dataSize,
    out int actualDataSize,
    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.

• data
  Type: []

  The buffer to retrieve the key into.

• dataSize
  Type: System.Int32

  The size of the buffer.

• actualDataSize
  Type: System.Int32

  Returns the actual size of the data.

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

  Retrieve key options.

See also

Reference

Api class

Api members

Microsoft.Isam.Esent.Interop namespace