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

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

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

Go to the source code of this file.

Classes

struct  VIBDatabase
 Wrapper for TIBDatabase. More...
 

Functions

VIBDLLFUNC VIBDatabase *VIBCALL VIBDatabase_New ()
 Constructor.
 
VIBDLLFUNC void VIBCALL VIBDatabase_Destroy (VIBDatabase *vdb)
 Destructor.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CloseDataSets (VIBDatabase *vdb)
 Close all datasets.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CheckActive (VIBDatabase *vdb)
 Check if the database is active.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CheckInactive (VIBDatabase *vdb)
 Check if the database is inactive.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CreateDatabase (VIBDatabase *vdb)
 Create a database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_DropDatabase (VIBDatabase *vdb)
 Drop a database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_ForceClose (VIBDatabase *vdb)
 Force-close the connection.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_IndexOfDBConst (VIBDatabase *vdb, const char *st, int *ret)
 Get the index of a DBConst.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_TestConnected (VIBDatabase *vdb)
 Test the database connection state.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CheckDatabaseName (VIBDatabase *vdb)
 Check if the database name is defined.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Call (VIBDatabase *vdb, int ErrCode, VIBBOOL RaiseError, int *ret)
 Execute an InterBase API call.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_AddTransaction (VIBDatabase *vdb, VIBTransaction *vtr, int *ret)
 Add a transaction to this database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_FindTransaction (VIBDatabase *vdb, VIBTransaction *vtr, int *ret)
 Check if the transaction is associated with this database.
 
VIBDLLFUNC VIBTransaction *VIBCALL VIBDatabase_FindDefaultTransaction (VIBDatabase *vdb)
 Get the default transaction instance for this database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_RemoveTransaction (VIBDatabase *vdb, int Idx)
 Remove a transaction from this database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_RemoveTransactions (VIBDatabase *vdb)
 Remove all transactions from this database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetHandle (VIBDatabase *vdb, void **Value)
 Set the database's InterBase API handle.
 
VIBDLLFUNC void **VIBCALL VIBDatabase_Handle (VIBDatabase *vdb)
 Obtain the database's InterBase API handle.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_IsReadOnly (VIBDatabase *vdb)
 Check the IsReadyOnly property.
 
VIBDLLFUNC VIBString *VIBCALL VIBDatabase_DBParamByDPB (VIBDatabase *vdb, int Idx)
 Get a DBParam for a DPB value.
 
VIBDLLFUNC int VIBCALL VIBDatabase_SQLObjectCount (VIBDatabase *vdb)
 Get the count of SQLObjects attached to the database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_HandleIsShared (VIBDatabase *vdb)
 Test if the database handle is shared.
 
VIBDLLFUNC int VIBCALL VIBDatabase_TransactionCount (VIBDatabase *vdb)
 Get a count of transactions attached to the database.
 
VIBDLLFUNC VIBTransaction *VIBCALL VIBDatabase_Transactions (VIBDatabase *vdb, int Index)
 Get a transaction attached to the database by index.
 
VIBDLLFUNC VIBTransaction *VIBCALL VIBDatabase_InternalTransaction (VIBDatabase *vdb)
 Get the internal transaction instance for the database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Has_DEFAULT_VALUE (VIBDatabase *vdb, const char *Relation, const char *Field)
 Get the DEFAULT_VALUE property of the indicated relation.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Has_COMPUTED_BLR (VIBDatabase *vdb, const char *Relation, const char *Field)
 Get the COMPUTED_BLR property of the indicated relation.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_FlushSchema (VIBDatabase *vdb)
 Flush the database schema.
 
VIBDLLFUNC VIBString *VIBCALL VIBDatabase_GetDatabaseName (VIBDatabase *vdb)
 Get the database name property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetDatabaseName (VIBDatabase *vdb, const char *name)
 Set the database name property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Params_Add (VIBDatabase *vdb, const char *param)
 Add a parameter to the database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_GetLoginPrompt (VIBDatabase *vdb)
 Get the LoginPrompt property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetLoginPrompt (VIBDatabase *vdb, VIBBOOL LoginPrompt)
 Set the LoginPrompt property.
 
VIBDLLFUNC VIBTransaction *VIBCALL VIBDatabase_GetDefaultTransaction (VIBDatabase *vdb)
 Get the default transaction attached to this database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetDefaultTransaction (VIBDatabase *vdb, VIBTransaction *vtr)
 Set the database's default transaction.
 
VIBDLLFUNC int VIBCALL VIBDatabase_GetIdleTimer (VIBDatabase *vdb)
 Get the IdleTimer property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetIdleTimer (VIBDatabase *vdb, int IdleTimer)
 Set the IdleTimer property.
 
VIBDLLFUNC int VIBCALL VIBDatabase_GetSQLDialect (VIBDatabase *vdb)
 Get the SQLDialict property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetSQLDialect (VIBDatabase *vdb, int SQLDialect)
 Set the SQLDialect property.
 
VIBDLLFUNC int VIBCALL VIBDatabase_DBSQLDialect (VIBDatabase *vdb)
 Get the DBSQLDialect property.
 
VIBDLLFUNC VIBTraceFlags VIBCALL VIBDatabase_GetTraceFlags (VIBDatabase *vdb)
 Get the database trace flags.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetTraceFlags (VIBDatabase *vdb, VIBTraceFlags flags)
 Set the database trace flags.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_GetAllowStreamedConnected (VIBDatabase *vdb)
 Get the AllowStreamedConnected property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetAllowStreamedConnected (VIBDatabase *vdb, VIBBOOL AllowStreamedConnected)
 Set the AllowStreamedConnected property.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Open (VIBDatabase *vdb)
 Open the database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Close (VIBDatabase *vdb)
 Close the database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_GetConnected (VIBDatabase *vdb)
 Get the connected status of the database.
 
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetConnected (VIBDatabase *vdb, VIBBOOL Connected)
 Set the connected status of the database (connects if set to VIBTRUE and not conected).
 
VIBDLLFUNC VIBDataSet *VIBCALL VIBDatabase_DataSets (VIBDatabase *vdb, int Index)
 Get a pointer to a specific dataset associated with this database.
 
VIBDLLFUNC int VIBCALL VIBDatabase_DataSetCount (VIBDatabase *vdb)
 Get a count of datasets attached to this database.
 

Detailed Description

VisualIB - InterBase wrapper for use in Visual Studio.

TIBDatabase Wrapper

Author
James Haley

Function Documentation

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_AddTransaction ( VIBDatabase vdb,
VIBTransaction vtr,
int *  ret 
)

Add a transaction to this database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Call ( VIBDatabase vdb,
int  ErrCode,
VIBBOOL  RaiseError,
int *  ret 
)

Execute an InterBase API call.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CheckActive ( VIBDatabase vdb)

Check if the database is active.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CheckDatabaseName ( VIBDatabase vdb)

Check if the database name is defined.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CheckInactive ( VIBDatabase vdb)

Check if the database is inactive.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Close ( VIBDatabase vdb)

Close the database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CloseDataSets ( VIBDatabase vdb)

Close all datasets.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_CreateDatabase ( VIBDatabase vdb)

Create a database.

VIBDLLFUNC int VIBCALL VIBDatabase_DataSetCount ( VIBDatabase vdb)

Get a count of datasets attached to this database.

VIBDLLFUNC VIBDataSet* VIBCALL VIBDatabase_DataSets ( VIBDatabase vdb,
int  Index 
)

Get a pointer to a specific dataset associated with this database.

Warning
You must destroy the VIBDataSet instance when you are finished with it.
VIBDLLFUNC VIBString* VIBCALL VIBDatabase_DBParamByDPB ( VIBDatabase vdb,
int  Idx 
)

Get a DBParam for a DPB value.

Warning
You must destroy the VIBString instance when you are finished with it.
VIBDLLFUNC int VIBCALL VIBDatabase_DBSQLDialect ( VIBDatabase vdb)

Get the DBSQLDialect property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_DropDatabase ( VIBDatabase vdb)

Drop a database.

VIBDLLFUNC VIBTransaction* VIBCALL VIBDatabase_FindDefaultTransaction ( VIBDatabase vdb)

Get the default transaction instance for this database.

Warning
You must destroy the VIBTransaction instance when you are finished with it.
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_FindTransaction ( VIBDatabase vdb,
VIBTransaction vtr,
int *  ret 
)

Check if the transaction is associated with this database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_FlushSchema ( VIBDatabase vdb)

Flush the database schema.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_ForceClose ( VIBDatabase vdb)

Force-close the connection.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_GetAllowStreamedConnected ( VIBDatabase vdb)

Get the AllowStreamedConnected property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_GetConnected ( VIBDatabase vdb)

Get the connected status of the database.

VIBDLLFUNC VIBString* VIBCALL VIBDatabase_GetDatabaseName ( VIBDatabase vdb)

Get the database name property.

Warning
You must destroy the VIBString instance when you are finished with it.
VIBDLLFUNC VIBTransaction* VIBCALL VIBDatabase_GetDefaultTransaction ( VIBDatabase vdb)

Get the default transaction attached to this database.

Warning
You must destroy the VIBTransaction instance when you are finished with it.
VIBDLLFUNC int VIBCALL VIBDatabase_GetIdleTimer ( VIBDatabase vdb)

Get the IdleTimer property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_GetLoginPrompt ( VIBDatabase vdb)

Get the LoginPrompt property.

VIBDLLFUNC int VIBCALL VIBDatabase_GetSQLDialect ( VIBDatabase vdb)

Get the SQLDialict property.

VIBDLLFUNC VIBTraceFlags VIBCALL VIBDatabase_GetTraceFlags ( VIBDatabase vdb)

Get the database trace flags.

VIBDLLFUNC void** VIBCALL VIBDatabase_Handle ( VIBDatabase vdb)

Obtain the database's InterBase API handle.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_HandleIsShared ( VIBDatabase vdb)

Test if the database handle is shared.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Has_COMPUTED_BLR ( VIBDatabase vdb,
const char *  Relation,
const char *  Field 
)

Get the COMPUTED_BLR property of the indicated relation.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Has_DEFAULT_VALUE ( VIBDatabase vdb,
const char *  Relation,
const char *  Field 
)

Get the DEFAULT_VALUE property of the indicated relation.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_IndexOfDBConst ( VIBDatabase vdb,
const char *  st,
int *  ret 
)

Get the index of a DBConst.

VIBDLLFUNC VIBTransaction* VIBCALL VIBDatabase_InternalTransaction ( VIBDatabase vdb)

Get the internal transaction instance for the database.

Warning
You must destroy the VIBTransaction instance when you are finished with it.
VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_IsReadOnly ( VIBDatabase vdb)

Check the IsReadyOnly property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Open ( VIBDatabase vdb)

Open the database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_Params_Add ( VIBDatabase vdb,
const char *  param 
)

Add a parameter to the database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_RemoveTransaction ( VIBDatabase vdb,
int  Idx 
)

Remove a transaction from this database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_RemoveTransactions ( VIBDatabase vdb)

Remove all transactions from this database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetAllowStreamedConnected ( VIBDatabase vdb,
VIBBOOL  AllowStreamedConnected 
)

Set the AllowStreamedConnected property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetConnected ( VIBDatabase vdb,
VIBBOOL  Connected 
)

Set the connected status of the database (connects if set to VIBTRUE and not conected).

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetDatabaseName ( VIBDatabase vdb,
const char *  name 
)

Set the database name property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetDefaultTransaction ( VIBDatabase vdb,
VIBTransaction vtr 
)

Set the database's default transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetHandle ( VIBDatabase vdb,
void **  Value 
)

Set the database's InterBase API handle.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetIdleTimer ( VIBDatabase vdb,
int  IdleTimer 
)

Set the IdleTimer property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetLoginPrompt ( VIBDatabase vdb,
VIBBOOL  LoginPrompt 
)

Set the LoginPrompt property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetSQLDialect ( VIBDatabase vdb,
int  SQLDialect 
)

Set the SQLDialect property.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_SetTraceFlags ( VIBDatabase vdb,
VIBTraceFlags  flags 
)

Set the database trace flags.

VIBDLLFUNC int VIBCALL VIBDatabase_SQLObjectCount ( VIBDatabase vdb)

Get the count of SQLObjects attached to the database.

VIBDLLFUNC VIBBOOL VIBCALL VIBDatabase_TestConnected ( VIBDatabase vdb)

Test the database connection state.

VIBDLLFUNC int VIBCALL VIBDatabase_TransactionCount ( VIBDatabase vdb)

Get a count of transactions attached to the database.

VIBDLLFUNC VIBTransaction* VIBCALL VIBDatabase_Transactions ( VIBDatabase vdb,
int  Index 
)

Get a transaction attached to the database by index.

Warning
You must destroy the VIBTransaction instance when you are finished with it.