Api.RetrieveColumnAsByte method (JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit)

Retrieves a byte column value from the current record. The record is that record associated with the index entry at the current position of the cursor.

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

Syntax

'Declaration
Public Shared Function RetrieveColumnAsByte ( _
    sesid As JET_SESID, _
    tableid As JET_TABLEID, _
    columnid As JET_COLUMNID, _
    grbit As RetrieveColumnGrbit _
) As Nullable(Of Byte)
'Usage
Dim sesid As JET_SESID
Dim tableid As JET_TABLEID
Dim columnid As JET_COLUMNID
Dim grbit As RetrieveColumnGrbit
Dim returnValue As Nullable(Of Byte)

returnValue = Api.RetrieveColumnAsByte(sesid, _
    tableid, columnid, grbit)

public static Nullable<byte> RetrieveColumnAsByte(
    JET_SESID sesid,
    JET_TABLEID tableid,
    JET_COLUMNID columnid,
    RetrieveColumnGrbit 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 column from.

• columnid
  Type: Microsoft.Isam.Esent.Interop.JET_COLUMNID

  The columnid to retrieve.

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

  Retrieval options.

Return value

Type: System.Nullable<Byte>
The data retrieved from the column as a byte. Null if the column is null.

See also

Reference

Api class

Api members

RetrieveColumnAsByte overload

Microsoft.Isam.Esent.Interop namespace