Retrieves the size of a single column value from the current record. The record is that record associated with the index entry at the current position of the cursor. Alternatively, this function can retrieve a column from a record being created in the cursor copy buffer. This function can also retrieve column data from an index entry that references the current record.
Namespace: Microsoft.Isam.Esent.Interop
Assembly: Microsoft.Isam.Esent.Interop (in Microsoft.Isam.Esent.Interop.dll)
Syntax
'Declaration
Public Shared Function RetrieveColumnSize ( _
sesid As JET_SESID, _
tableid As JET_TABLEID, _
columnid As JET_COLUMNID, _
itagSequence As Integer, _
grbit As RetrieveColumnGrbit _
) As Nullable(Of Integer)
'Usage
Dim sesid As JET_SESID
Dim tableid As JET_TABLEID
Dim columnid As JET_COLUMNID
Dim itagSequence As Integer
Dim grbit As RetrieveColumnGrbit
Dim returnValue As Nullable(Of Integer)
returnValue = Api.RetrieveColumnSize(sesid, _
tableid, columnid, itagSequence, _
grbit)
public static Nullable<int> RetrieveColumnSize(
JET_SESID sesid,
JET_TABLEID tableid,
JET_COLUMNID columnid,
int itagSequence,
RetrieveColumnGrbit grbit
)
Parameters
-
sesid
Type: Microsoft.Isam.Esent.Interop.JET_SESIDThe session to use.
-
tableid
Type: Microsoft.Isam.Esent.Interop.JET_TABLEIDThe cursor to retrieve the column from.
-
columnid
Type: Microsoft.Isam.Esent.Interop.JET_COLUMNIDThe columnid to retrieve.
-
itagSequence
Type: System.Int32The sequence number of value in a multi-valued column. The array of values is one-based. The first value is sequence 1, not 0. If the record column has only one value then 1 should be passed as the itagSequence.
-
grbit
Type: Microsoft.Isam.Esent.Interop.RetrieveColumnGrbitRetrieve column options.
Return value
Type: System.Nullable<Int32>
The size of the column. 0 if the column is null.
See also
Reference
Microsoft.Isam.Esent.Interop namespace
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
