vibtransaction.h File Reference

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

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

Go to the source code of this file.

Classes
struct	VIBTransaction
	Wrapper for a TIBTransaction. More...

Functions
VIBDLLFUNC VIBTransaction *VIBCALL	VIBTransaction_New ()
	Constructor.
VIBDLLFUNC void VIBCALL	VIBTransaction_Destroy (VIBTransaction *vtr)
	Destructor.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_Call (VIBTransaction *vtr, int ErrCode, VIBBOOL RaiseError, int *ret)
	Execute an InterBase API call.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_Commit (VIBTransaction *vtr)
	Commit and close the transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_CommitRetaining (VIBTransaction *vtr)
	Commit the transaction and retain its active state.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_Rollback (VIBTransaction *vtr)
	Rollback and close the transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_RollbackRetaining (VIBTransaction *vtr)
	Rollback the transaction and retain its active state.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_StartTransaction (VIBTransaction *vtr)
	Start the transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_CheckInTransaction (VIBTransaction *vtr)
	Check if the transaction is active.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_CheckNotInTransaction (VIBTransaction *vtr)
	Check if the transaction is not active.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_CheckAutoStop (VIBTransaction *vtr)
	Check the AutoStop property.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_AddDatabase (VIBTransaction *vtr, VIBDatabase *vdb, int *ret)
	Add a database to this transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_FindDatabase (VIBTransaction *vtr, VIBDatabase *vdb, int *ret)
	Check if the database is related to this transaction.
VIBDLLFUNC VIBDatabase *VIBCALL	VIBTransaction_FindDefaultDatabase (VIBTransaction *vtr)
	Obtain the default database property of this transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_RemoveDatabase (VIBTransaction *vtr, int Idx)
	Remove a database from the transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_RemoveDatabases (VIBTransaction *vtr)
	Remove all databases from the transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_CheckDatabasesInList (VIBTransaction *vtr)
	Check if there are databases attached to the transaction.
VIBDLLFUNC int VIBCALL	VIBTransaction_DatabaseCount (VIBTransaction *vtr)
	Obtain a count of the databases related to this transaction.
VIBDLLFUNC VIBDatabase *VIBCALL	VIBTransaction_Databases (VIBTransaction *vtr, int Index)
	Obtain a pointer to the Nth database associated with the transaction.
VIBDLLFUNC int VIBCALL	VIBTransaction_SQLObjectCount (VIBTransaction *vtr)
VIBDLLFUNC void *VIBCALL	VIBTransaction_Handle (VIBTransaction *vtr)
	Obtain the transaction's handle.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_HandleIsShared (VIBTransaction *vtr)
	Test if the handle is shared.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_InTransaction (VIBTransaction *vtr)
	Test if the transaction is running.
VIBDLLFUNC char *VIBCALL	VIBTransaction_TPB (VIBTransaction *vtr)
	Get the TPB property.
VIBDLLFUNC short VIBCALL	VIBTransaction_TPBLength (VIBTransaction *vtr)
	Get the length of the TPB property.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_GetActive (VIBTransaction *vtr)
	Get the active state of the transaction.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_SetActive (VIBTransaction *vtr, VIBBOOL Active)
	Set the active state of the transaction.
VIBDLLFUNC VIBDatabase *VIBCALL	VIBTransaction_GetDefaultDatabase (VIBTransaction *vtr)
	Get the transaction's default database.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_SetDefaultDatabase (VIBTransaction *vtr, VIBDatabase *DefaultDatabase)
	Set the transaction's default database.
VIBDLLFUNC int VIBCALL	VIBTransaction_GetIdleTimer (VIBTransaction *vtr)
	Get the IdleTimer property.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_SetIdleTimer (VIBTransaction *vtr, int IdleTimer)
	Set the IdleTimer property.
VIBDLLFUNC VIBTransactionAction VIBCALL	VIBTransaction_GetDefaultAction (VIBTransaction *vtr)
	Get the transaction's default action.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_SetDefaultAction (VIBTransaction *vtr, VIBTransactionAction action)
	Set the transaction's default action.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_Params_Add (VIBTransaction *vtr, const char *Param)
	Add a parameter to the transaction.
VIBDLLFUNC VIBAutoStopAction VIBCALL	VIBTransaction_GetAutoStopAction (VIBTransaction *vtr)
	Get the transaction's autostop action.
VIBDLLFUNC VIBBOOL VIBCALL	VIBTransaction_SetAutoStopAction (VIBTransaction *vtr, VIBAutoStopAction action)
	Set the transaction's autostop action.

Detailed Description

VisualIB - InterBase wrapper for use in Visual Studio.

TIBTransaction Wrapper

Author

James Haley

Function Documentation

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

Add a database to this transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_CheckAutoStop

(

VIBTransaction *

vtr

)

Check the AutoStop property.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_CheckDatabasesInList

(

VIBTransaction *

vtr

)

Check if there are databases attached to the transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_CheckInTransaction

(

VIBTransaction *

vtr

)

Check if the transaction is active.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_CheckNotInTransaction

(

VIBTransaction *

vtr

)

Check if the transaction is not active.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_Commit

(

VIBTransaction *

vtr

)

Commit and close the transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_CommitRetaining

(

VIBTransaction *

vtr

)

Commit the transaction and retain its active state.

VIBDLLFUNC int VIBCALL VIBTransaction_DatabaseCount

(

VIBTransaction *

vtr

)

Obtain a count of the databases related to this transaction.

VIBDLLFUNC VIBDatabase* VIBCALL VIBTransaction_Databases	(	VIBTransaction *	vtr,
		int	Index
	)

Obtain a pointer to the Nth database associated with the transaction.

Warning

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

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

Check if the database is related to this transaction.

VIBDLLFUNC VIBDatabase* VIBCALL VIBTransaction_FindDefaultDatabase

(

VIBTransaction *

vtr

)

Obtain the default database property of this transaction.

Warning

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

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_GetActive

(

VIBTransaction *

vtr

)

Get the active state of the transaction.

VIBDLLFUNC VIBAutoStopAction VIBCALL VIBTransaction_GetAutoStopAction

(

VIBTransaction *

vtr

)

Get the transaction's autostop action.

VIBDLLFUNC VIBTransactionAction VIBCALL VIBTransaction_GetDefaultAction

(

VIBTransaction *

vtr

)

Get the transaction's default action.

VIBDLLFUNC VIBDatabase* VIBCALL VIBTransaction_GetDefaultDatabase

(

VIBTransaction *

vtr

)

Get the transaction's default database.

Warning

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

VIBDLLFUNC int VIBCALL VIBTransaction_GetIdleTimer

(

VIBTransaction *

vtr

)

Get the IdleTimer property.

VIBDLLFUNC void* VIBCALL VIBTransaction_Handle

(

VIBTransaction *

vtr

)

Obtain the transaction's handle.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_HandleIsShared

(

VIBTransaction *

vtr

)

Test if the handle is shared.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_InTransaction

(

VIBTransaction *

vtr

)

Test if the transaction is running.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_Params_Add	(	VIBTransaction *	vtr,
		const char *	Param
	)

Add a parameter to the transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_RemoveDatabase	(	VIBTransaction *	vtr,
		int	Idx
	)

Remove a database from the transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_RemoveDatabases

(

VIBTransaction *

vtr

)

Remove all databases from the transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_Rollback

(

VIBTransaction *

vtr

)

Rollback and close the transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_RollbackRetaining

(

VIBTransaction *

vtr

)

Rollback the transaction and retain its active state.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_SetActive	(	VIBTransaction *	vtr,
		VIBBOOL	Active
	)

Set the active state of the transaction.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_SetAutoStopAction	(	VIBTransaction *	vtr,
		VIBAutoStopAction	action
	)

Set the transaction's autostop action.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_SetDefaultAction	(	VIBTransaction *	vtr,
		VIBTransactionAction	action
	)

Set the transaction's default action.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_SetDefaultDatabase	(	VIBTransaction *	vtr,
		VIBDatabase *	DefaultDatabase
	)

Set the transaction's default database.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_SetIdleTimer	(	VIBTransaction *	vtr,
		int	IdleTimer
	)

Set the IdleTimer property.

VIBDLLFUNC VIBBOOL VIBCALL VIBTransaction_StartTransaction

(

VIBTransaction *

vtr

)

Start the transaction.

VIBDLLFUNC char* VIBCALL VIBTransaction_TPB

(

VIBTransaction *

vtr

)

Get the TPB property.

VIBDLLFUNC short VIBCALL VIBTransaction_TPBLength

(

VIBTransaction *

vtr

)

Get the length of the TPB property.