Api.RetrieveColumnAsString method (JET_SESID, JET_TABLEID, JET_COLUMNID, Encoding)

Retrieves a string 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 RetrieveColumnAsString ( _
    sesid As JET_SESID, _
    tableid As JET_TABLEID, _
    columnid As JET_COLUMNID, _
    encoding As Encoding _
) As String
'Usage
Dim sesid As JET_SESID
Dim tableid As JET_TABLEID
Dim columnid As JET_COLUMNID
Dim encoding As Encoding
Dim returnValue As String

returnValue = Api.RetrieveColumnAsString(sesid, _
    tableid, columnid, encoding)

public static string RetrieveColumnAsString(
    JET_SESID sesid,
    JET_TABLEID tableid,
    JET_COLUMNID columnid,
    Encoding encoding
)

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.

• encoding
  Type: System.Text.Encoding

  The string encoding to use when converting data.

Return value

Type: System.String
The data retrieved from the column as a string. Null if the column is null.

See also

Reference

Api class

Api members

RetrieveColumnAsString overload

Microsoft.Isam.Esent.Interop namespace