VisualIB  1.0
IBExpress library for making use of Borland IBExpress outside of C++Builder
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
vibdataset.h File Reference

VisualIB - InterBase wrapper for use in Visual Studio. More...

#include "vibdefines.h"
#include "vibtypes.h"
#include "vibdatabase.h"
#include "vibtransaction.h"
#include "vibstring.h"

Go to the source code of this file.

Classes

struct  VIBDataSet
 Wrapper for TIBDataSet. More...
 

Functions

VIBDLLFUNC VIBDataSet *VIBCALL VIBDataSet_New ()
 Constructor.
 
VIBDLLFUNC void VIBCALL VIBDataSet_Destroy (VIBDataSet *vds)
 Destructor.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_SetDatabase (VIBDataSet *vds, VIBDatabase *vdb)
 Set the VIBDatabase instance for the VIBDataSet.
 
VIBDLLFUNC VIBDatabase *VIBCALL VIBDataSet_GetDatabase (VIBDataSet *vds)
 Retrieve the VIBDatabase instance for the VIBDataSet.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_SetTransaction (VIBDataSet *vds, VIBTransaction *vtr)
 Set the VIBTransaction instance for the VIBDataSet.
 
VIBDLLFUNC VIBTransaction *VIBCALL VIBDataSet_GetTransaction (VIBDataSet *vds)
 Retrieve the VIBTransaction instance for the VIBDataSet.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_SetUniDirectional (VIBDataSet *vds, VIBBOOL UniDirectional)
 Set the UniDirectional property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_GetUniDirectional (VIBDataSet *vds)
 Get the UniDirectional property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_SelectSQL_Clear (VIBDataSet *vds)
 Clear the SelectSQL statement list.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_SelectSQL_Add (VIBDataSet *vds, const char *sql)
 Add a string to the SelectSQL statement list.
 
VIBDLLFUNC VIBString *VIBCALL VIBDataSet_SelectSQL_GetText (VIBDataSet *vds)
 Obtain all SQL statements as a single string.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_SelectSQL_SetText (VIBDataSet *vds, const char *sql)
 Set the text of the SelectSQL list to a single string.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_Eof (VIBDataSet *vds)
 Check if the dataset is at the end of its set of records.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_Open (VIBDataSet *vds)
 Open the dataset by executing the SelectSQL statement.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_First (VIBDataSet *vds)
 Place the dataset cursor at the first record.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_Next (VIBDataSet *vds)
 Step to the next record in the dataset.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_Close (VIBDataSet *vds)
 Close the dataset.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_Prepare (VIBDataSet *vds)
 Prepare the dataset's SelectSQL statement but do not execute it.
 
VIBDLLFUNC VIBString *VIBCALL VIBDataSet_Plan (VIBDataSet *vds)
 Obtain a plan for the SelectSQL statement.
 
VIBDLLFUNC int VIBCALL VIBDataSet_Fields_Count (VIBDataSet *vds)
 Get a count of the fields according to the TFields subobject.
 
VIBDLLFUNC VIBString *VIBCALL VIBDataSet_Fields_AsString (VIBDataSet *vds, int Index)
 Get the value of a specific field as a string.
 
VIBDLLFUNC VIBString *VIBCALL VIBDataSet_Fields_FieldName (VIBDataSet *vds, int Index)
 Get the name of a specific field as a string.
 
VIBDLLFUNC VIBString *VIBCALL VIBDataSet_FieldByName_AsString (VIBDataSet *vds, const char *fieldname)
 Get the value of a specific field, found by field name, as a string.
 
VIBDLLFUNC int VIBCALL VIBDataSet_FieldCount (VIBDataSet *vds)
 Get a count of the fields according to the TIBDataSet itself.
 
VIBDLLFUNC VIBFieldType VIBCALL VIBDataSet_Fields_DataType (VIBDataSet *vds, int Idx)
 Get the type of a specific field in the data set.
 
VIBDLLFUNC VIBFieldKind VIBCALL VIBDataSet_Fields_FieldKind (VIBDataSet *vds, int Idx)
 Get the kind of a specific field in the data set.
 

Detailed Description

VisualIB - InterBase wrapper for use in Visual Studio.

TIBDataSet Wrapper

Author
James Haley

Function Documentation

VIBDLLFUNC VIBString* VIBCALL VIBDataSet_FieldByName_AsString ( VIBDataSet vds,
const char *  fieldname 
)

Get the value of a specific field, found by field name, as a string.

Warning
You must destroy the VIBString instance when you are finished with it.
VIBDLLFUNC int VIBCALL VIBDataSet_FieldCount ( VIBDataSet vds)

Get a count of the fields according to the TIBDataSet itself.

VIBDLLFUNC VIBString* VIBCALL VIBDataSet_Fields_AsString ( VIBDataSet vds,
int  Index 
)

Get the value of a specific field as a string.

Warning
You must destroy the VIBString instance when you are finished with it.
VIBDLLFUNC int VIBCALL VIBDataSet_Fields_Count ( VIBDataSet vds)

Get a count of the fields according to the TFields subobject.

VIBDLLFUNC VIBFieldType VIBCALL VIBDataSet_Fields_DataType ( VIBDataSet vds,
int  Idx 
)

Get the type of a specific field in the data set.

VIBDLLFUNC VIBFieldKind VIBCALL VIBDataSet_Fields_FieldKind ( VIBDataSet vds,
int  Idx 
)

Get the kind of a specific field in the data set.

VIBDLLFUNC VIBString* VIBCALL VIBDataSet_Fields_FieldName ( VIBDataSet vds,
int  Index 
)

Get the name of a specific field as a string.

Warning
You must destroy the VIBString instance when you are finished with it.
VIBDLLFUNC VIBDatabase* VIBCALL VIBDataSet_GetDatabase ( VIBDataSet vds)

Retrieve the VIBDatabase instance for the VIBDataSet.

Warning
You must destroy the VIBDatabase when you are finished with it.
VIBDLLFUNC VIBTransaction* VIBCALL VIBDataSet_GetTransaction ( VIBDataSet vds)

Retrieve the VIBTransaction instance for the VIBDataSet.

Warning
You must destroy the VIBTransaction when you are finished with it.
VIBDLLFUNC VIBString* VIBCALL VIBDataSet_Plan ( VIBDataSet vds)

Obtain a plan for the SelectSQL statement.

Precondition
The dataset's query must be prepared first.
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_Prepare ( VIBDataSet vds)

Prepare the dataset's SelectSQL statement but do not execute it.

VIBDLLFUNC VIBString* VIBCALL VIBDataSet_SelectSQL_GetText ( VIBDataSet vds)

Obtain all SQL statements as a single string.

Warning
You must destroy the VIBString instance when you are finished with it.
VIBDLLFUNC VIBBOOL VIBCALL VIBDataSet_SelectSQL_SetText ( VIBDataSet vds,
const char *  sql 
)

Set the text of the SelectSQL list to a single string.