Edit

Api.JetRetrieveColumns method

  • Article

Retrieves multiple column values from the current record in a single operation. An array of JET_RETRIEVECOLUMN structures is used to describe the set of column values to be retrieved, and to describe output buffers for each column value to be retrieved.

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

Syntax

'Declaration
Public Shared Function JetRetrieveColumns ( _
    sesid As JET_SESID, _
    tableid As JET_TABLEID, _
    retrievecolumns As JET_RETRIEVECOLUMN(), _
    numColumns As Integer _
) As JET_wrn
'Usage
Dim sesid As JET_SESID
Dim tableid As JET_TABLEID
Dim retrievecolumns As JET_RETRIEVECOLUMN()
Dim numColumns As Integer
Dim returnValue As JET_wrn

returnValue = Api.JetRetrieveColumns(sesid, _
    tableid, retrievecolumns, numColumns)

public static JET_wrn JetRetrieveColumns(
    JET_SESID sesid,
    JET_TABLEID tableid,
    JET_RETRIEVECOLUMN[] retrievecolumns,
    int numColumns
)

Parameters

  • retrievecolumns
    Type: []

    An array of one or more JET_RETRIEVECOLUMN objects describing the data to be retrieved.

  • numColumns
    Type: System.Int32

    The number of entries in the columns array.

Return value

Type: Microsoft.Isam.Esent.Interop.JET_wrn
If any column retrieved is truncated due to an insufficient length buffer, then the API will return BufferTruncated. However other errors JET_wrnColumnNull are returned only in the error field of the JET_RETRIEVECOLUMN object.

See also

Reference

Api class

Api members

Microsoft.Isam.Esent.Interop namespace