Copyright: Copyright © 2001 Borland Software Corporation.                      All rights reserved.                                                 This Help file was compiled on   Tuesday, May 15, 2001 14:51:56.


 EIBClientError

Hierarchy 	Properties	Methods	See also

EIBClientError represents a client-specific error in an InterBase Express application.

Unit

IB

Description

Use EIBClientError to raise an exception for client-specific errors. It is raised when an application tries to use a component improperly. For example, an EIBClientError is raised when a component can’t access the database because it does not have an IBDatabase component specified, attempts to edit a read-only dataset, tries to execute an empty query, and so on.


EIBClientError properties

EIBClientError	Alphabetically	Legend

Derived from EIBError

IBErrorCode

SQLCode

Derived from Exception

HelpContext

Message


EIBClientError properties

EIBClientError	By object	Legend

HelpContext

IBErrorCode

Message

SQLCode


EIBClientError methods

EIBClientError	Alphabetically	Legend

Derived from EIBError

Create

Derived from Exception

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIBError methods

EIBClientError	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


Hierarchy

TObject

Exception

EDatabaseErrror

EIBErrror

EIBClientError


 EIBError

Hierarchy 	Properties	Methods	See also

EIBError is the exception class for InterBase errors.

Unit

IB

Description

Use EIBError to raise an exception when a component detects an error in the database or in the component implementation. EIBError is the base class for all errors that arise in the use of InterBase Express. Its descendants represent specific types of errors, and include EIBClientError, EIBInterBaseError, and EIBInterbaseRoleError.


EIBError properties

EIBError	Alphabetically	Legend

In EIBError

IBErrorCode

SQLCode

Derived from Exception

HelpContext

Message


EIBError properties

EIBError	By object	Legend

HelpContext

IBErrorCode

Message

SQLCode


EIBError.IBErrorCode

EIBError	See also

Returns the InterBase error code.

property IBErrorCode: Long;

Description

Use IBErrorCode to get the InterBase error code.


EIBError.SQLCode

EIBError	See also

Translates an InterBase error code in the error status vector to an SQL error number code.

property SQLCode: Long;

Description

Use SQLCode to translate an InterBase error code in the error status vector to an SQL error number code.  Typically, this call is used to populate a program variable with an SQL error number for use in an SQL error-handling routine.


EIBError methods

EIBError	Alphabetically	Legend

In EIBError

Create

Derived from Exception

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIBError methods

EIBError	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIBError.Create

EIBError	See also

Calls the inherited Create and sets the SQLCode and IBErrorCode

constructor Create(ASQLCode: Long; Msg: string);

constructor Create(ASQLCode: Long; AIBErrorCode: Long; Msg: string);

Description

Use Create to call to the inherited Create and sets the SQL code and IBErrorCode.


Hierarchy

TObject

Exception

EDatabaseError

EIBError


 EIBInterBaseError

Hierarchy 	Properties	Methods	See also

EIBInterBaseError is used to raise server-specific errors.

Unit

IB

Description

Use EIBInterBaseError to raise an exception that represents an error code that the InterBase server returns.


EIBInterBaseError properties

EIBInterBaseError	Alphabetically	Legend

Derived from EIBError

IBErrorCode

SQLCode

Derived from Exception

HelpContext

Message


EIBInterBaseError properties

EIBInterBaseError	By object	Legend

HelpContext

IBErrorCode

Message

SQLCode


EIBInterBaseError methods

EIBInterBaseError	Alphabetically	Legend

Derived from EIBError

Create

Derived from Exception

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIBInterBaseError methods

EIBInterBaseError	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


Hierarchy

TObject

Exception

EDatabaseErrror

EIBErrror

EIBInterBaseError


EIBInstall

Hierarchy	Properties	Methods	See also

EIBInstall catches all of the installation exceptions.

Unit

IBInstall

Description

Use EIBInstall to catch installation exceptions from InterBase and InterBase Express (IBX).

Note: You must install InterBase 6 to use this feature.


EIBInstall properties

EIBInstall	Alphabetically	Legend

In EIBInstall

InstallerError

InstallError

Derived from Exception

HelpContext

Message


EIBInstall properties

EIBInstall	By object	Legend

HelpContext

InstallerError

InstallError

Message


EIBInstall.InstallerError

EIBInstall	See also

Returns IBX error messages.

type TIBInstallerError = set of (ieSuccess, ieDelphiException, ieNoDestinationDirectory, ieNosourceDirectory, ieNouninstallFile, ieOptionNeedsClient, ieOptionNeedsServer, ieInvalidOption, ieInvalidOnErrorResult, ieInvalidOnStatusResult);

property InstallerError: TIBInstallerError;

Use InstallerError to return error messages generated by the IBX install components. InstallerError can be one of:

ieSuccess	Installation is successful
ieDelphiException	Installation fails due to a Delphi exception
ieNoOptionsSet	Installation fails because no installation options are set
ieNoDestinationDirectory	Installation fails because no destination directory is set
ieNoSourceDirectory	Installation fails because no source directory is set
ieNoUninstallFile	Installation fails because no uninstall file is named
ieOptionNeedsClient	Installation fails because the installation needs the InterBase Client component to succeed
ieOptionNeedsServer	Installation fails because the installation needs the InterBase Server component to succeed
ieInvalidOption	Option is invalid
ieInvalidOnErrorResult	The OnError event result is invalid
ieInvalidOnStatusResult	The OnStatus event result is invalid
Note: You must install InterBase 6 to use this feature.


EIBInstall.InstallError

EIBInstall	See also

Returns InterBase installation error messages.

property InstallError: MSG_NO;

Use InstallError to return error messages generated by the InterBase API.

Note: You must install InterBase 6 to use this feature.


EIBInstall methods

EIBInstall	Alphabetically	Legend

In EIBInstall

Create

Derived from Exception

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


EIBInstall methods

EIBInstall	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


EIBInstall.Create

EIBInstall	See also

Creates an instance of an EIBInstall object.

constructor Create(ECode: TIBInstallerError; EMessage: String);

constructor Create(IscCode: MSG_NO; IscMessage: String);

Description

Call Create to create an instance of an EIBInstall exception object.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

Exception

EIBInstall


 EIBInterbaseRoleError

Hierarchy 	Properties	Methods	See also

EIBInterbaseRoleError is the exception class for InterBase errors that arise when a caller’s role does not have sufficient rights.

Unit

IB

Description

EIBInterbaseRoleError is raised when InterBase reports failure due to an incorrect role.


EIBInterbaseRoleError properties

EIBInterbaseRoleError	Alphabetically	Legend

In EIBError

IBErrorCode

SQLCode

Derived from Exception

HelpContext

Message


EIBInterbaseRoleError properties

EIBInterbaseRoleError	By object	Legend

HelpContext

IBErrorCode

Message

SQLCode


EIBInterbaseRoleError methods

EIBInterbaseRoleError	Alphabetically	Legend

Derived from EIBError

Create

Derived from Exception

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


EIBInterbaseRoleError methods

EIBInterbaseRoleError	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

CreateFmt

CreateFmtHelp

CreateHelp

CreateRes

CreateResFmt

CreateResFmtHelp

CreateResHelp

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


Hierarchy

TObject

Exception

EDatabaseError

EIBError

EIBInterbaseRoleError


Getting started
Getting started with InterBase Express

InterBase Express (IBX) is a set of data access components that provide a means of accessing data from InterBase databases. The InterBase Administration Components, which require InterBase 6, are described after the InterBase data access components.

The following components are located on the InterBase tab of the component palette.

	TIBTable
	TIBQuery
	TIBStoredProc
	TIBDatabase
	TIBTransaction
	TIBUpdateSQL
	TIBDataSet
	TIBSQL
	TIBDatabaseInfo
	TIBSQLMonitor
	TIBEvents
	TIBExtract
	TIBClientDataSet
This document assumes that you are familiar with the Delphi development environment and know how to use the Standard, Data Access, and Data Control components.

Though they are similar to BDE components in name, the IBX components are somewhat different. For each component with a BDE counterpart, the sections below give a discussion of these differences.

There is no simple migration from BDE to IBX applications. Generally, you must replace BDE components with the comparable IBX components, and then recompile your applications. However, the speed you gain, along with the access you get to the powerful InterBase features make migration well worth your time.

IBDatabase

Use an IBDatabase component to establish connections to databases, which can involve one or more concurrent transactions. Unlike BDE, IBX has a separate transaction component, which allows you to separate transactions and database connections.

To set up a database connection:

1.	Drop an IBDatabase component onto a form or data module.

2.	Fill out the DatabaseName property. For a local connection, this is the drive, path, and filename of the database file. Set the Connected property to True.

3.	Enter a valid username and password and click OK to establish the database connection.

Tip: You can store the username and password in the IBDatabase component's Params property by setting the LoginPrompt property to False after logging in. For example, after logging in as the system administrator and setting the LoginPrompt property to False, you may see the following when editing the Params property:

user_name=sysdba

password=masterkey

IBTransaction

Unlike the Borland Database Engine, IBX controls transactions with a separate component, IBTransaction. This powerful feature allows you to separate transactions and database connections, so you can take advantage of the InterBase two-phase commit functionality (transactions that span multiple connections) and multiple concurrent transactions using the same connection.

Use an IBTransaction component to handle transaction contexts, which might involve one or more database connections. In most cases, a simple one database/one transaction model will do.

To set up a transaction:

1.	Set up an IBDatabase connection as described above.

2.	Drop an IBTransaction component onto the form or data module

3.	Set the DefaultDatabase property to the name of your IBDatabase component.

4.	Set the Active property to True to start the transaction.

IBX dataset components

There are a variety of dataset components from which to choose with IBX, each having their own characteristics and task suitability:

IBTable

Use an  IBTable component to set up a live dataset on a table or view without having to enter any SQL statements.

IBTable components are easy to configure:

1.	Add an IBTable component to your form or data module.

2.	Specify the associated database and transaction components.

3.	Specify the name of the relation from the TableName drop-down list.

4.	Set the Active property to True.

IBQuery

Use an IBQuery component to execute any InterBase DSQL statement, restrict your result set to only particular columns and rows, use aggregate functions, and join multiple tables.

IBQuery components provide a read-only dataset, and adapt well to the InterBase client/server environment. To set up an IBQuery component:

1.	Set up an IBDatabase connection as described above.

2.	Set up an IBTransaction connection as described above.

3.	Add an IBQuery component to your form or data module.

4.	Specify the associated database and transaction components.

5.	Enter a valid SQL statement for the IBQuery’s SQL property in the String list editor.

6.	Set the Active property to True

IBDataSet

Use an IBDataSet component to execute any InterBase DSQL statement, restrict your result set to only particular columns and rows, use aggregate functions, and join multiple tables. IBDataSet components are similar to IBQuery components, except that they support live datasets without the need of an IBUpdateSQL component.

The following is an example that provides a live dataset for the COUNTRY table in employee.gdb:

1.	Set up an IBDatabase connection as described above.

2.	Specify the associated database and transaction components.

3.	Add an IBDataSet component to your form or data module.

4.	Enter SQL statements for the following properties:

SelectSQL	SELECT Country, Currency FROM Country
RefreshSQL	SELECT Country, Currency FROM Country WHERE Country = :Country
ModifySQL	UPDATE Country SET Country = :Country, Currency = :Currency WHERE Country = :Old_Country
DeleteSQL	DELETE FROM Country WHERE Country = :Old_Country
InsertSQL	INSERT INTO Country (Country, Currency) VALUES (:Country, :Currency)
1.	Set the Active property to True.

Note:  Parameters and fields passed to functions are case-sensitive in dialect 3. For example,

FieldByName(EmpNo)

would return nothing in dialect 3 if the field was ‘EMPNO’.

IBStoredProc

Use IBStoredProc for InterBase executable procedures: procedures that return, at most, one row of information. For stored procedures that return more than one row of data,  or "Select" procedures, use either IBQuery or IBDataSet components.

IBSQL

Use an IBSQL component for data operations that need to be fast and lightweight. Operations such as data definition and pumping data from one database to another are suitable for IBSQL components.

In the following example, an IBSQL component is used to return the next value from a generator:

1.	Set up an IBDatabase connection as described above.

2.	Put an IBSQL component on the form or data module and set its Database property to the name of the database.

3.	Add an SQL statement to the SQL property string list editor, for example:

SELECT GEN_ID(MyGenerator, 1) FROM RDB$DATABASE

IBUpdateSQL

Use an IBUpdateSQL component to update read-only datasets. You can update IBQuery output with an IBUpdateSQL component:

1.	Set up an IBQuery component as described above.

2.	Add an IBUpdateSQL component to your form or data module.

3.	Enter SQL statements for the following properties: DeleteSQL, InsertSQL, ModifySQL, and RefreshSQL.

4.	Set the IBQuery component’s UpdateObject property to the name of the IBUpdateSQL component.

5.	Set the IBQuery component’s Active property to True.

IBSQLMonitor

Use an IBSQLMonitor component to develop diagnostic tools to monitor the communications between your application and the InterBase server. When the TraceFlags properties of an IBDatabase component are turned on, active IBSQLMonitor components can keep track of the connection's activity and send the output to a file or control.

A good example would be to create a separate application that has an IBSQLMonitor component and a Memo control. Run this secondary application, and on the primary application, activate the TraceFlags of the IBDatabase component. Interact with the primary application, and watch the second's memo control fill with data.

IBDatabaseInfo

Use an IBDatabaseInfo component to retrieve information about a particular database, such as the sweep interval, ODS version, and the user names of those currently attached to this database.

For example, to set up an IBDatabaseInfo component that displays the users currently connected to the database:

1.	Set up an IBDatabase connection as described above.

2.	Put an IBDatabaseInfo component on the form or data module and set its Database property to the name of the database.

3.	Put a Memo component on the form.

4.	Put a Timer component on the form and set its interval.

5.	Double click on the Timer’s OnTimer event field and enter code similar to the following:

Memo1.Text := IBDatabaseInfo.UserNames.Text;

IBEvents

Use an IBEvents component to register interest in, and asynchronously handle, events posted by an InterBase server.

To set up an IBEvents component:

1.	Set up an IBDatabase connection as described above.

2.	Put an IBEvents component on the form or data module and set its Database property to the name of the database.

3.	Enter events in the Events property string list editor, for example:

IBEvents.Events.Add('EVENT_NAME');

4.	Set the Registered property to True.

InterBase Administration Components

If you have InterBase 6 installed, you can use the InterBase 6 Administration components, which allow you to use access the powerful InterBase Services API calls.

The components are located on the InterBase Admin tab of Delphi and include:

	TIBConfigService
	TIBBackupService
	TIBRestoreService
	TIBValdationService
	TIBStatisticalService
	TIBLogService
	TIBSecurityService
	TIBLicensingService
	TIBServerProperties
	TIBInstall
	TIBUninstall
Note: You must install InterBase 6 to use these features.

IBConfigService

Use an IBConfigService object to configure database parameters, including page buffers, async mode, reserve space, and sweep interval.

IBBackupService

Use an IBBackupService object to back up your database.  With IBBackupService, you can set such parameters as the blocking factor, backup file name, and database backup options.

IBRestoreService

Use an IBRestoreService object to restore your database.  With IBRestoreService, you can set such options as page buffers, page size, and database restore options.

IBValidationService

Use an IBValidationService object to validate your database and reconcile your database transactions.  With the IBValidationService, you can set the default transaction action, return limbo transaction information, and set other database validation options.

IBStatisticalService

Use an IBStatisticalService object to view database statistics, such as data pages, database log, header pages, index pages, and system relations.

IBLogService

Use an IBLogService object to create a log file.

IBSecurityService

Use an IBSecurityService object to manage user access to the InterBase server.  With the IBSecurityService, you can create, delete, and modify user accounts, display all users, and set up work groups using SQL roles.

IBLicensingService

Use an IBLicensingService component to add or remove InterBase software activation certificates.

IBServerProperties

Use an IBServerProperties component to return database server information, including configuration parameters, and version and license information.

IBInstall

Use an IBInstall component to set up an InterBase installation component, including the installation source and destination directories, and the components to be installed.

IBUnInstall

Use an IBUnInstall component to set up an uninstall component.


TIBBase

Hierarchy	Properties	Methods	Events	See also

TIBBase is the ancestor object from which TIBTransaction descends.

Unit

IBDataBase

Description

TIBBase is the ancestor object from which TIBTransaction descends.


TIBBase properties

TIBBase	Alphabetically	Legend

In TIBBase

Database

DBHandle

Owner

Transaction

TRHandle


TIBBase properties

TIBBase	By object	Legend

Database

DBHandle

Owner

Transaction

TRHandle


TIBBase.Database

TIBBase	See also

Sets or returns the associated database.

property Database: TIBDatabase;

Description

Use Database to set or return the associated database.


TIBBase.DBHandle

TIBBase	See also

Indicates the database handle.

property DBHandle: PISC_DB_HANDLE;

Description

Use DBHandle to return the database handle.


TIBBase.Owner

TIBBase	See also

Indicates which component owns the component.

property Owner: TObject;

Description

Owner refers to the SQL object (DataSet, TIBSQL, or Blob) that created the TIBBase component.


TIBBase.Transaction

TIBBase	See also

Sets or returns the associated transaction.

property Transaction: TIBTransaction;

Description

Use Transaction to set or return the associated transaction.


TIBBase.TRHandle

TIBBase	See also

Returns the transaction handle.

property TRHandle: PISC_TR_HANDLE;

Description

Use TRHandle to return the transaction handle.


TIBBase events

TIBBase	Alphabetically	Legend

In TIBBase

AfterDatabaseDisconnect

AfterTransactionEnd

BeforeDatabaseDisconnect

BeforeTransactionEnd

OnDatabaseFree

OnTransactionFree


TIBBase events

TIBBase	By object	Legend

AfterDatabaseDisconnect

AfterTransactionEnd

BeforeDatabaseDisconnect

BeforeTransactionEnd

OnDatabaseFree

OnTransactionFree


TIBBase.AfterDatabaseDisconnect

TIBBase	See also

Occurs after a database is disconnected.

property AfterDatabaseDisconnect: TNotifyEvent;

Description

Write an AfterDatabaseDisconnect event handler to take specific actions after a database is disconnected.


TIBBase.AfterTransactionEnd

TIBBase	See also

Occurs after a transaction has ended.

property AfterTransactionEnd: TNotifyEvent;

Description

Write an AfterTransactionEnd event handler to take specific actions after a transaction has ended.


TIBBase.BeforeDatabaseDisconnect

TIBBase	See also

Occurs before a database disconnects.

property BeforeDatabaseDisconnect: TNotifyEvent;

Description

Write a BeforeDatabaseDisconnect event handler to take specific actions before a database disconnects.


TIBBase.BeforeTransactionEnd

TIBBase	See also

Occurs before a transaction ends.

property BeforeTransactionEnd: TNotifyEvent;

Description

Write a BeforeTransactionEnd event handler to take specific actions before a transaction ends.


TIBBase.OnDatabaseFree

TIBBase	See also

Occurs after a database is freed from memory.

property OnDatabaseFree: TNotifyEvent;

Description

Write an OnDatabaseFree event handler to take specific actions after a database is freed from memory.


TIBBase.OnTransactionFree

TIBBase	See also

Occurs after a transaction has been freed from memory.

property OnTransactionFree: TNotifyEvent;

Description

Write an OnTransactionFree event handler to take specific actions after a transaction has been freed from memory.


TIBBase methods

TIBBase	Alphabetically	Legend

In TIBBase

CheckDatabase

CheckTransaction

Create

Destroy

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBBase methods

TIBBase	By object	Legend

AfterConstruction

BeforeDestruction

CheckDatabase

CheckTransaction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBBase.CheckDatabase

TIBBase	See also

Checks if the database is active.

procedure CheckDatabase;

Description

Call CheckDatabase to check if the database is assigned and active.


TIBBase.CheckTransaction

TIBBase	See also

Checks if the transaction is active.

procedure CheckTransaction;

Description

Call CheckTransaction to check if the transaction is assigned and active.


TIBBase.Create

TIBBase	See also

Creates an instance of an IBBase object.

constructor Create(AOwner: TObject);

Description

Call Create to create an instance of an IBBase object.


TIBBase.Destroy

TIBBase	See also

Destroys an IBBase object.

destructor Destroy;

Description

Call Destroy to destroy an IBBase object and to free up any resources associated with it.


Hierarchy

TObject

TIBBase


TIBBatch

Hierarchy	Properties	Methods	See also 	Example

TIBBatch is the abstract base class for the TIBBatchInput and TIBBatchOutput objects.

Unit

IBSQL

Description

Use a TIBBatch object to provide properties and methods for use with the TIBBatchInput and TIBBatchOutput objects, which make it possible to input and output data in virtually any format.

Descendents of this class can specify a file name (for input or output), and a TIBXSQLDA object representing a record or parameters.  The ReadyFile method is called right before performing the batch input or output.


TIBBatch properties

TIBBatch	Alphabetically	Legend

In TIBBatch

Columns

Filename

Params


TIBBatch properties

TIBBatch	By object	Legend

Columns

Filename

Params


TIBBatch.Columns

TIBBatch	See also

Returns the XSQLDA columns.

property Columns: TIBXSQLDA;

Description

Use the Columns property to retrieve or set the XSQLDA columns.


TIBBatch.Filename

TIBBatch	See also

Sets or displays the name of the external file.

property Filename: String;

Description

Use the Filename property to set or display the external file name.


TIBBatch.Params

TIBBatch	See also

Returns the XSQLDA parameters.

property Params: TIBXSQLDA;

Description

Use the Params property to retrieve or set the XSQLDA parameters.


TIBBatch methods

TIBBatch	Alphabetically	Legend

In TIBBatch

ReadyFile

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBBatch methods

TIBBatch	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadyFile

SafeCallException


TIBBatch.ReadyFile

TIBBatch	See also

Prepares the file.

procedure ReadyFile; virtual; abstract;

Description

Call ReadyFile to prepare the file for input or output.


Hierarchy

TObject

TIBBatch


 TIBBatchInput

Hierarchy	Properties	Methods	See also 	Example

TIBBatchInput is the abstract class for performing all batch input.

Unit

IBSQL

Description

Use a TIBBatchInput object to provide properties and methods for performing all batch input.


TIBBatchInput properties

TIBBatchInput	Alphabetically	Legend

Derived from TIBBatch

Columns

FileName

Params


TIBBatchInput properties

TIBBatchInput	By object	Legend

Columns

FileName

Params


TIBBatchInput methods

TIBBatchOutput	Alphabetically	Legend

In TIBBatchInput

ReadParameters

Derived from TIBBatch

ReadyFile

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBBatchInput methods

TIBBatch	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadParameters

ReadyFile

SafeCallException


TIBBatchInput.ReadParameters

TIBBatchInput	See also

Reads the XSQLDA input parameters.

function ReadParameters: Boolean; virtual; abstract;

Description

Call ReadParameters to read the input parameters of the extended SQL descriptor area (XSQLDA) from the specified file.


Hierarchy

TObject

TIBBatch

TIBBatchInput


 TIBBatchMove

Hierarchy	Properties	Methods	See also

TIBBatchMove enables applications to perform database operations on groups of records or entire tables.

Unit

IBBatchMove

Description

Set the properties of the TIBBatchMove object to

Add the records in a dataset to a database table.

Delete the records in a dataset from a database table.

Copy a dataset to create a new database table or overwrite an existing table.

Call the Execute method to perform the actual operation. TIBTable objects can also perform the same batch operations, but only with the options specified by the default TIBBatchMove property values.


TIBBatchMove properties

TIBBatchMove	Alphabetically	Legend

In TIBBatchMove

AbortOnKeyViol

AbortOnProblem

ChangedCount

ChangedTableName

CommitCount

Destination

KeyViolCount

KeyViolTableName

Mappings

Mode

MovedCount

ProblemCount

ProblemTableName

RecordCount

Source

Transliterate

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBBatchMove properties

TIBBatchMove	By object	Legend

AbortOnKeyViol

AbortOnProblem

ChangedCount

ChangedTableName

CommitCount

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Destination

KeyViolCount

KeyViolTableName

Mappings

Mode

MovedCount

Name

Owner

ProblemCount

ProblemTableName

RecordCount

Source

Tag

Transliterate

VCLComObject


TIBBatchMove.AbortOnKeyViol

TIBBatchMove	See also

Specifies whether the batch operation is terminated immediately when integrity or key violations occur.

property AbortOnKeyViol: Boolean;

Description

Set AbortOnKeyViol to True (the default) to cancel the batch operation when it causes integrity or key violations in the destination table. Set AbortOnKeyViol to False to cause records that would cause integrity or key violations to be posted to a key violations table instead. Provide a KeyViolTableName when setting AbortOnKeyViol to False. If there is no KeyViolTableName, AbortOnKeyViol may still be set to False, in which case problem records are counted but not saved in a table.

Key violations occur when appending records to a table that has a primary key. On a table with a primary key, no two records may have the same values on all of the key fields. If a record that is being appended has the same values on all the key fields as a record in the destination table, it cannot be appended.

Integrity violations occur when deleting, appending or updating records to a table that has a referential integrity specification. A referential integrity specification requires that certain fields in one table must have values that exist in a particular field of another table. If a record that is being added does not match the restrictions imposed by referential integrity, it cannot be added. If deleting record would cause tighter referential integrity restrictions that another table cannot meet, it cannot be deleted.


TIBBatchMove.AbortOnProblem

TIBBatchMove	See also

Specifies whether the batch operation is terminated immediately when it is necessary to truncate data to make it fit in the specified Destination.

property AbortOnProblem: Boolean;

Description

Set AbortOnProblem to True to cancel the batch operation when types of the fields in the Source table records do not match the types of the fields in the Destination table records. Set AbortOnProblem to False to cause the mismatched fields to be “trimmed”. When AbortOnProblem is False, set the ProblemTableName to have all the untrimmed versions of records that were trimmed saved to a separate table.

Trimming a field means converting its value to a value compatible with the destination field type. For example, if a field in the destination table holds a string of size 10 characters, and the corresponding field in the source table holds a string of size 15 characters, any values from the source table longer than 10 characters must be truncated. Values that cannot be converted will cause TIBBatchMove to raise an exception.

Trimming does not occur when the Mode property is set to batCopy. Trimming fields on a delete operation means that records in the destination table that do not exactly match the values from the source table may be deleted.


TIBBatchMove.ChangedCount

TIBBatchMove	See also

Indicates the number of records from the Destination table that are altered as a result of the batch operation.

property ChangedCount: Longint;

Description

Use ChangedCount to learn the number of records in the Destination table that are updated when the Mode is batUpdate or batAppendUpdate, or to learn the number that are deleted when the Mode is batDelete.

Set the ChangedTableName property to save the unchanged versions of the altered records to a separate table. ChangedCount is then the number of records in that separate table.


TIBBatchMove.ChangedTableName

TIBBatchMove	See also

Specifies the name of a local Interbase table that is created to hold copies of all records from the destination table that are changed by the batch operation.

type TFileName = type string;

property ChangedTableName: TFileName;

Description

Set ChangedTableName to create a table that saves all unchanged versions of records that are changed by the batch operation. ChangedTableName must specify the name of a Interbase table. Setting ChangedTableName ensures that no information in the Destination table gets lost when the records are altered or deleted.

When the Mode property is batUpdate or batAppendUpdate, the new table will hold all records that were updated. When the Mode property is batDelete, the new table will hold all records that were deleted.

The ChangedCount property specifies the number of records in the new table.


TIBBatchMove.CommitCount

TIBBatchMove	See also

Specifies how many records are batch moved before a commit occurs.

property CommitCount: Integer;

Description

Use CommitCount to chunk batch operations into smaller operations. CommitCount allows an application to accommodate server transaction logs that are not big enough to handle the entire batch. Setting CommitCount to 0 will cause chunking into the number of records that will fit in 32K bytes.

Note:	If the Execute method is called within an explicit transaction on the database containing the tables, CommitCount is ignored.


TIBBatchMove.Destination

TIBBatchMove	See also

Specifies the TIBTable object for the database table that is the destination of the batch operation.

property Destination: TIBTable;

Description

Use Destination to indicate the database table that will be created or altered by the batch operation. The batch operation affects the Destination differently depending on the Mode:

Mode	Effect on Destination

batAppend	Records are added to the destination table. No pre-existing records are altered. The destination table must already exist.

batUpdate	Records in the destination table with key fields matching the corresponding fields in the source are changed to match the source records. No new records are added. The destination table must already exist and must have an index defined.

batAppendUpdate	Records in the destination table with key fields matching the corresponding fields in the source are changed to match the source. Source records that do not match key fields are added to the destination table. The destination table must already exist and must have an index defined.

batDelete	Records in the destination table that match the records in the source are deleted. The destination table must already exist and must have an index defined.

batCopy	The destination table is created to match the records in the source. If Destination already exists, it is replaced by the copy of the source.


TIBBatchMove.KeyViolCount

TIBBatchMove	See also

Reports the number of records that could not be replaced, added, or deleted from Destination because of integrity or key violations.

property KeyViolCount: Longint;

Description

Use KeyViolCount to learn the number of records form the Source table that could not be applied to the Destination table because of integrity or key violations. To obtain a table of the offending records from the Source table, specify a KeyViolTableName.

Key violations occur when appending records to a table that has a primary key. On a table with a primary key, no two records may have the same values on all of the key fields. If a record that is being appended has the same values on all the key fields as a record in the destination table, it cannot be appended.

Integrity violations occur when deleting, appending or updating records to a table that has a referential integrity specification. A referential integrity specification requires that certain fields in one table must have values that exist in a particular field of another table. If a record that is being added does not match the restrictions imposed by referential integrity, it cannot be added. If deleting record would cause tighter referential integrity restrictions that another table cannot meet, it cannot be deleted.

Note:	If AbortOnKeyViol is True, KeyViolCount will never be greater than one, because the first violation will cause the batch operation to terminate.


TIBBatchMove.KeyViolTableName

TIBBatchMove	See also

Specifies the name of an InterBase table that will be created to contain all records from the Source that cannot participate in the batch operation because of integrity or key violations.

type TFileName = type string;

property KeyViolTableName: TFileName;

Description

Use KeyViolTableName to obtain a table of records that could not be applied to the Destination table because of integrity or key violations. KeyViolCount has the number of records in the table that is created.

Key violations occur when appending records to a table that has a primary key. On a table with a primary key, no two records may have the same values on all of the key fields. If a record that is being appended has the same values on all the key fields as a record in the destination table, it cannot be appended.

Integrity violations occur when deleting, appending or updating records to a table that has a referential integrity specification. A referential integrity specification requires that certain fields in one table must have values that exist in a particular field of another table. If a record that is being added does not match the restrictions imposed by referential integrity, it cannot be added. If deleting record would cause tighter referential integrity restrictions that another table cannot meet, it cannot be deleted.

Note:	If AbortOnKeyViol is True, then there will be at most one record in this table because the operation aborts with that first record.


TIBBatchMove.Mappings

TIBBatchMove	See also

Specifies the column mappings for a batch operation.

property Mappings: TStrings;

Description

Set Mappings to specify the correspondence between fields in the Source and fields in the Destination. By default TIBBatchMove matches fields based on their position in the source and destination tables. That is, the first column in the source is matched with the first column in the destination, and so on. Mappings enables an application to override this default.

Mappings is a list of column mappings (one per line) in one of two forms. To map the column ColName in the source table to the column of the same name in the destination table, use:

ColName

To map the column named SourceColName in the source table to the column named DestColName in the destination table, use:

DestColName=SourceColName

When adding or appending records, fields in Destination which have no entry in Mappings will be set to NULL. When copying a dataset, fields in Destination which have no entry in Mappings will not appear as columns in the copy of the table.

If source and destination column data types are not the same, TIBBatchMove can either cancel the batch operation or perform a “best fit.” If AbortOnProblem is True, type mismatches will terminate the batch move. Otherwise, the field values from the Source will be converted, if possible, to be compatible with the Destination.


TIBBatchMove.Mode

TIBBatchMove	See also

Specifies what the TIBBatchMove object does when the Execute method is called.

type TBatchMode = (batAppend, batUpdate, batAppendUpdate, batDelete, batCopy);

property Mode: TBatchMode;

Description

Use Mode to indicate whether the TIBBatchMove object should add records, replace records, delete records, or copy the Source. These are the possible values for Mode:

Value	Meaning

batAppend	Append the records in the source to the destination table. The destination table must already exist, and the two tables must not have records with duplicate keys. This is the default mode.

batUpdate	Replace records in the destination table with matching records from the source table. The destination table must exist and must have an index defined to match records.

batAppendUpdate	If a matching record exists in the destination table, replace it. Otherwise, append records to the destination table. The destination table must exist and must have an index defined to match records.

batCopy	Create the destination table based on the structure of the source table. If the destination already exists, the operation will delete it, and replace it with the new copy of the source.

batDelete	Delete records in the destination table that match records in the source table. The destination table must already exist and must have an index defined.


TIBBatchMove.MovedCount

TIBBatchMove	See also

Reports the number of records form the Source which were applied to the destination.

property MovedCount: Longint;

Description

Read MovedCount to learn the number of records from the Source that were read during the Execute method. The MovedCount value includes any records which caused key or integrity violations, or which were trimmed.


TIBBatchMove.ProblemCount

TIBBatchMove	See also

Indicates the number of records which could not be added to Destination without loss of data due to a field type mismatch.

property ProblemCount: Longint;

Description

Read ProblemCount to learn the number of records from the Source that had field values that could not be mapped to destination fields without being “trimmed”. If a ProblemTableName is specified, ProblemCount is the number of records in that table.

Trimming a field means converting its value to a value compatible with the destination field type. For example, if a field in the destination table holds a string of size 10 characters, and the corresponding field in the source table holds a string of size 15 characters, any values from the source table longer than 10 characters must be truncated. Values that cannot be converted will cause TIBBatchMove to raise an exception.

Trimming does not occur when the Mode property is set to batCopy. Trimming fields on a delete operation means that records in the destination table may be deleted that do not exactly match the values from the source table.

Note:	If AbortOnProblem is True, then ProblemCount will be at most one, because the operation aborts when the problem occurs.


TIBBatchMove.ProblemTableName

TIBBatchMove	See also

Specifies the name of a Interbase table that will be created to contain all records from the Source that contain fields which were trimmed to match the corresponding field type in the Destination table.

type TFileName = type string;

property ProblemTableName: TFileName;

Description

Set ProblemTableName to create a table that holds records from the Source that contain fields that had to be trimmed to be applied to the Destination. ProblemCount will have the number of records placed in the new table. If ProblemTableName is not specified, the data in the record is still trimmed when applied to the destination table, but there will be no easy way to tell which fields were trimmed.

Trimming a field means converting its value to a value compatible with the destination field type. For example, if a field in the destination table holds a string of size 10 characters, and the corresponding field in the source table holds a string of size 15 characters, any values from the source table longer than 10 characters must be truncated. Values that cannot be converted will cause TIBBatchMove to raise an exception.

Trimming does not occur when the Mode property is set to batCopy. Trimming fields on a delete operation means that records in the destination table may be deleted that do not exactly match the values from the source table.

Note:	If AbortOnProblem is True, then there will be at most one record in this table because the operation aborts with the first record that has a problem.


TIBBatchMove.RecordCount

TIBBatchMove	See also

Specifies the maximum number of records that are applied to the Destination when Execute is called.

property RecordCount: Longint;

Description

Use RecordCount to limit the number of Source records that are applied to the Destination. If zero, all records are added, subtracted, or copied, beginning with the first record in Source. If RecordCount is greater than zero, up to RecordCount records are applied to the Destination, starting with the current record in the dataset. If RecordCount exceeds the number of records remaining in Source, no wraparound occurs; the operation is terminated.


TIBBatchMove.Source

TIBBatchMove	See also

Specifies the dataset that is the source of the batch operation.

property Source: TIBCustomDataSet;

Description

Use Source to indicate the dataset that contains the records that will be added to, subtracted from, or copied to the Destination. If Source is a TIBQuery component, the query is executed before the move is executed. If a filter is currently in effect on Source, the filter conditions are respected when the batch move executes. The Mode property indicates how the Source records are applied to the Destination:

Mode	Effect on Destination

batAppend	Records are added to the destination table.

batUpdate	Records in the destination table with key fields matching the corresponding fields in the source are changed to match the source records.

batAppendUpdate	Records in the destination table with key fields matching the corresponding fields in the source are changed to match the source. Source records that do not match key fields are added to the destination table.

batDelete	Records in the destination table that match the records in the source are deleted.

batCopy	Destination table is created to match the records in the source.


TIBBatchMove.Transliterate

TIBBatchMove	See also

Specifies whether the data in the Source records should be converted form the locale of the Source to the locale of the Destination when the Execute method is called.

property Transliterate: Boolean;

Description

Set Transliterate to True when the Source dataset and the Destination table use different language drivers and the data may contain extended ASCII characters. Set Transliterate to False to avoid the overhead of the character set conversion when both the Source and the Destination use the same language driver or the data does not contain extended ASCII characters.


TIBBatchMove methods

TIBBatchMove	Alphabetically	Legend

In TIBBatchMove

Create

Destroy

Execute

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBBatchMove methods

TIBBatchMove	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

Execute

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction


TIBBatchMove.Create

TIBBatchMove	See also

Creates an instance of TIBBatchMove.

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBBatchMove for performing a batch operation. Create allocates the memory for the TIBBatchMove object and

•	Sets AbortOnKeyViol to True.

•	Sets AbortOnProblem to True.

•	Sets Transliterate to True.

•	Creates a TStringList object to hold the Mappings.

The property settings made by Create are the values used when a TIBTable object performs batch operations using its BatchMove method.


TIBBatchMove.Destroy

TIBBatchMove	See also

Destroys an instance of TIBBatchMove.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TIBBatchMove object is not already freed and only then calls Destroy.

Before calling the inherited destructor, Destroy frees the TStringList object that implements the Mappings property.


TIBBatchMove.Execute

TIBBatchMove	See also

Performs the batch operation specified by Mode.

procedure Execute;

Description

After setting properties to indicate what batch operation should be performed and how, call Execute to perform the operation. As a minimum, the Mode, Source, and Destination properties must be set.

After calling Execute, the values of the ChangedCount, KeyViolCount, MovedCount, ProblemCount, and RecordCount properties will become available. These properties will give an indication of what happened as a result of the call to Execute. Additional information about the batch operation will be available through the creation of a changed table, a keyviol table, and/or a problems table if it was requested.


Hierarchy

TObject

TPersistent

TComponent

TIBBatchMove


 TIBBatchOutput

Hierarchy	Properties	Methods	See also	Example

TIBBatchOutput is the abstract class for performing all batch output.

UnitIBSQL

Use a TIBBatchOutput object to provide properties and methods for performing all batch output.


TIBBatchOutput properties

TIBBatchOutput	Alphabetically	Legend

Derived from TIBBatch

Columns

FileName

Params


TIBBatchOutput properties

TIBBatchOutput	By object	Legend

Columns

FileName

Params


TIBBatchOutput methods

TIBBatchOutput	Alphabetically	Legend

In TIBBatchOutput

WriteColumns

Derived from TIBBatch

ReadyFile

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBBatchOutput methods

TIBBatch	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadyFile

SafeCallException

WriteColumns


TIBBatchOutput.WriteColumns

TIBBatchOutput	See also

Outputs the data in columns in the XSQLDA to the specified file.

function WriteColumns: Boolean; virtual, abstract;

Description

Call WriteColumns to output data in columns in the extended SQL descriptor area (XSQLDA) to the specified file.


Hierarchy

TObject

TIBBatch

TIBBatchOutput


 TIBBCDField

Hierarchy	Properties	Methods 	Events	See also

TIBBCDField represents a numeric field as a Currency type..

Unit

IBCustomDataSet

Description

TIBBCDField encapsulates the Currency type. Despite the name, TIBBCDField does not represent a BCD value. Rather, TIBBCDFields represent InterBase Numeric(x, y) fields, where x < 18 and y <= 4.


TIBBCDField properties

TIBBCDField	Alphabetically	Legend

In TIBBCDField

AsCurrency

AsString

AsVariant

DataSize

Value

Derived from TBCDField

AsBCD

AsFloat

AsInteger

Currency

MaxValue

MinValue

Precision

Derived from TNumericField

DisplayFormat

EditFormat

Derived from TField

Alignment

AsBoolean

AsDateTime

Calculated

AsSQLTimeStamp

AttributeSet

AutoGenerateValue

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

FullName

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ParentField

ProviderFlags

ReadOnly

Required

Text

Size

ValidChars

Visible

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBBCDField properties

TIBBCDField	By object	Legend

Alignment

AsBCD

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsSQLTimeStamp

AsString

AsVariant

AttributeSet

AutoGenerateValue

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

Currency

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayFormat

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditFormat

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

FullName

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

MaxValue

MinValue

Name

NewValue

Offset

OldValue

Origin

Owner

ParentField

Precision

ProviderFlags

ReadOnly

Required

Size

Tag

Text

ValidChars

Value

VCLComObject

Visible


TIBBCDField.AsCurrency

TIBBCDField	See also

Represents the field’s value as a Currency value.

property AsCurrency: Currency;

Description

AsCurrency provides a property to read the value of the field’s data into an object or variable of type Currency, or to assign a Currency value to the contents of the field. TIBBCDField reads and writes the value of the field as a Currency value.


TIBBCDField.AsString

TIBBCDField

Represents the field’s value as a string.

property AsString: string;

Description

Reading the AsString property returns the abbreviated class name of the field component enclosed in parentheses. The abbreviated class name is built by stripping the leading ‘T’ from the class name and removing the trailing word ‘FIELD’, except in the case of TField where that would leave an empty string. Thus, the abbreviated class name of TField is “FIELD”, the abbreviated class name of TVarBytesField is “VarBytes”, and so on.

AsString reads and writes the value of the field as a different, more meaningful, string.


TIBBCDField.AsVariant

TIBBCDField	See also

Represents the Value of the field as type Variant.

property AsVariant: Variant;

Description

AsVariant provides a property to read the value of the field’s data into a Variant, or to assign a Variant value to the contents of the field.

The AsVariant method gets or sets the value of the field as a Variant.


TIBBCDField.DataSize

TIBBCDField	See also

Indicates the amount of memory needed to store a field component’s value.

property DataSize: Integer;

Description

Check DataSize to determine the number of bytes required to store a field component’s value. Use DataSize to determine the required size of a buffer for working with the field’s value in native format. For example, use DataSize to determine the buffer size needed by the GetData and SetData methods.


TIBBCDField.Value

TIBBCDField	See also

Represents the data in a field component.

property Value: Variant;

Description

Use Value to read data directly from and write data directly to a field component at runtime. For example, use the Value property to affect the contents of a field that is not Visible.


TIBBCDField events

TIBBCDField	Alphabetically	Legend

Derived from TField

OnChange

OnGetText

OnSetText

OnValidate


TIBBCDField events

TIBBCDField	By object	Legend

OnChange

OnGetText

OnSetText

OnValidate


TIBBCDField methods

TIBBCDField	Alphabetically	Legend

In TIBBCDField

Create

Derived from TField

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

GetParentComponent

HasParent

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBBCDField methods

TIBBCDField	By object	Legend

AfterConstruction

Assign

AssignValue

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsImplementorOf

IsValidChar

MethodAddress

MethodName

NewInstance

ReferenceInterface

RefreshLookupList

RemoveComponent

RemoveFreeNotification

SafeCallException

SetData

SetFieldType

SetSubComponent

UpdateAction

Validate


TIBBCDField.Create

TIBBCDField	See also

Creates an instance of a TIBBCDField object.

constructor Create(AOwner: TComponent);

Description

Create sets the datatype to ftBCD and the size to 8.


Hierarchy

TObject

TPersistent

TComponent

TField

TNumericField

TBCDField

TIBBCDField


 TIBBackupRestoreService

Hierarchy	Properties 	Methods 	Events	See also

TIBBackupRestoreService is the ancestor object from which TIBBackupService and TIBRestoreService are derived.

Unit

IBServices

Description

TIBBackupRestoreService is the ancestor object from which TIBBackupService and TIBRestoreService are derived.

Note: You must install InterBase 6 to use this feature.


TIBBackupRestoreService properties

TIBBackupRestoreService	Alphabetically	Legend

In TIBBackupRestoreService

SQLRole

Verbose

Derived from TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBBackupRestoreService properties

TIBBackupRestoreService	By object	Legend

Active

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Eof

Handle

IsServiceRunning

LoginPrompt

Name

Owner

Params

Protocol

ServerName

ServiceParamBySPB

SQLRole

Tag

VCLComObject

Verbose


TIBBackupRestoreService.Verbose

TIBBackupRestoreService 	Example

Sets or returns the backup or restore in verbose mode.

property Verbose: Boolean;

Use Verbose to set or return the backup or restore in verbose mode.

Note: You must install InterBase 6 to use this feature.


TIBBackupRestoreService.SQLRole

TIBBackupRestoreService

Sets or returns the SQL role for the backup or restore.

property SQLRole: String;

Use SQLRole to set or return SQL role of the user performing the the backup or restore.

Note: You must install InterBase 6 to use this feature.


TIBBackupRestoreService events

TIBCustomService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBBackupRestoreService events

TIBCustomService	By object	Legend

OnAttach

OnLogin


TIBBackupRestoreService methods

TIBBackupRestoreService	Alphabetically	Legend

Derived from TIBControlAndQueryService

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Create

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName


TIBBackupRestoreService methods

TIBBackupRestoreService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService

TIBBackupRestoreService


 TIBBackupService

Hierarchy	Properties	Methods	Events	See also

TIBBackupService allows you to back up your database.

Unit

IBServices

Description

Use a TIBBackupService object to back up your database.


TIBBackupService properties

TIBBackupService	Alphabetically	Legend

In TIBBackupService

BackupFile

BlockingFactor

DatabaseName

Options

Derived from TIBBackupRestoreService

Verbose

Derived from TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBBackupService properties

TIBBackupService	By object	Legend

Active

BackupFile

BlockingFactor

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DatabaseName

DesignInfo

Eof

Handle

IsServiceRunning

LoginPrompt

Name

Options

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject

Verbose


TIBBackupService.BackupFile

TIBBackupService 	Example

Sets or returns the backup file name.

property BackupFile: TStrings;

Use BackupFile to set or return the backup file name.


TIBBackupService.BlockingFactor

TIBBackupService	See also

Sets or returns the blocking factor for the tape device.

property BlockingFactor: Integer;

Use BlockingFactor to set the blocking factor for the tape device as an integer.


TIBBackupService.DatabaseName

TIBBackupService	Example

Sets or returns the database name.

property DatabaseName: String;

Use DatabaseName to set or return the database name.


TIBBackupService.Options

TIBBackupService	See also 	Example

Sets the options for the database backup.

type TBackupOptions = set of (IgnoreChecksums, IgnoreLimbo, MetadataOnly, NoGarbageCollection, OldMetadataDesc, NonTransportable, ConvertExtTables);

property Options: TBackupOptions;

Use Options to select the options for the database backup.  TBackupOptions are:

IgnoreChecksums	A checksum is a page-by-page analysis of data to verify its integrity. A bad checksum means that a data page has been randomly overwritten, for example, due to a system crash. Checksum errors indicate data corruption, and InterBase normally prevents you from backing up a database if bad checksums are detected. Examine the data the next time you restore the database. To ignore checksums during backup, set IgnoreChecksums to True.
IgnoreLimbo	Limbo transactions are usually caused by the failure of a two-phased commit. They can also exist due to system failure or when a single-database transaction is prepared. To ignore limbo transactions during backup, set IgnoreLimbo to True. When your application ignores limbo transactions during backup, it ignores all records versions created by any limbo transaction, finds the most recently committed version of a record, and backs up that version.
MetadataOnly	When backing up a database, you can exclude its data, saving only the metadata. You might want to do this to: • Retain a record of the metadata before it is modified. • Create an empty copy of the database. The copy has the same metadata but can be populated with different data. Set MetaDataOnly to True to save only the metadata.
NoGarbageCollection	Garbage collections marks space used by old versions of data records as free for re-use. Generally, you want to perform garbage collection during backup. To disable garbage collection, set NoGarbageCollection to True.
OldMetadataDesc	Set OldMetadataDesc to True if you want to back up metadata in the old-style format.
NonTransportable	Set to NonTransportable to True if you do not want data to be moved to a machine with a different operating system than the one on which the backup was performed. If NonTransportable is set to False (the default), then data is saved in a generic format, enabling you to restore to any machine that supports InterBase.
ConvertExtTables	Set ConvertExtTables to True if you want to convert external files into internal tables during the backup


TIBBackupService events

TIBBackupService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBBackupService events

TIBBackupService	By object	Legend

OnAttach

OnLogin


TIBBackupService methods

TIBBackupService	Alphabetically	Legend

In TIBBackupService

Create

Destroy

Derived from TIBControlAndQueryService

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName


TIBBackupService methods

TIBBackupService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


TIBBackupService.Create

TIBBackupService	See also

Creates an instance of TIBBackupService

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBBackupService.


TIBBackupService.Destroy

TIBBackupService	See also

Destroys the service.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the service object has not already been freed before it calls Destroy.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService

TIBBackupRestoreService

TIBBackupService


TIBBlobStream

Hierarchy	Properties	Methods	See also

TIBBlobStream is a stream object that lets applications read from or write to field objects that represent Blob fields.

Unit

IBBlob

Description

Use TIBBlobStream to access or modify the value of a Blob field object. Blob field objects are TBlobField objects and descendants of TBlobField such as TGraphicField and TMemoField. Blob fields use Blob streams to implement many of their data access properties and methods.

TIBBlobStream allows objects that have no specialized knowledge of how data is stored in a Blob field to read or write such data by employing the uniform stream interface.

To use a Blob stream, create an instance of TIBBlobStream, use the methods of the stream to read or write the data, and then free the Blob stream. Do not use the same instance of TBlobStream to access data from more than one record. Instead, create a new TIBBlobStream object every time you need to read or write Blob data on a new record.


TIBBlobStream properties

TIBBlobStream	Alphabetically	Legend

In TIBBlobStream

BlobID

BlobMaxSegmentSize

BlobNumSegments

BlobSize

BlobType

Database

DBHandle

Handle

Mode

Modified

Transaction

TRHandle

Derived from TStream

Position

Size


TIBBlobStream properties

TIBBlobStream	By object	Legend

BlobID

BlobMaxSegmentSize

BlobNumSegments

BlobSize

BlobType

Database

DBHandle

Handle

Mode

Modified

Position

Size

Transaction

TRHandle


TIBBlobStream.BlobID

TIBBlobStream	See also

Sets or returns the Blob ID.

property BlobID: TISC_QUAD;

Description

Use BlobID to set or return the 64-bit system-defined Blob ID, which is stored in a field in the table and points to the first segment of the Blob or to a page of pointers to Blob fragments


TIBBlobStream.BlobMaxSegmentSize

TIBBlobStream	See also

Returns the maximum segment size.

property BlobMaxSegmentSize: Long;

Description

Use BlobMaxSegmentSize to return the length of the longest Blob segment.


TIBBlobStream.BlobNumSegments

TIBBlobStream	See also

Returns the total number of segments in the Blob.

property BlobNumSegments: Long;

Description

Use BlobNumSegments to return the total number of segments in the Blob.


TIBBlobStream.BlobSize

TIBBlobStream	See also

Returns the total size of the Blob.

property BlobSize: Long;

Description

Use BlobSize to return the total size of the Blob in bytes.


TIBBlobStream.BlobType

TIBBlobStream	See also

Returns the Blob type.

property BlobType: Short;

_Description

Use BlobType to return the Blob type; either 0 for segmented, or 1 for stream.


TIBBlobStream.Database

TIBBlobStream	See also

Sets or returns the associated database.

property Database: TIBDatabase;

Description

Use Database to set or return the associated database.


TIBBlobStream.DBHandle

TIBBlobStream	See also

Indicates the database handle.

property DBHandle: PISC_DB_HANDLE;

Description

Use DBHandle to return the database handle.


TIBBlobStream.Handle

TIBBlobStream	See also

Indicates the Blob handle.

property Handle: TISC_BLOB_HANDLE;

Description

Use Handle to return the Blob handle.


TIBBlobStream.Mode

TIBBlobStream	See also

Sets or returns the Blob stream mode type.

property Mode: TBlobStreamMode;

Description

Use Mode to set or read the Blob stream mode type. The Mode specifies whether the stream is used for reading BLOB values, writing BLOB values, or both.


TIBBlobStream.Modified

TIBBlobStream	See also

Indicates whether the Blob field has been modified.

property Modified: Boolean;

Description

Modified is True when the value to a Blob field has changed. If the value of the Blob field is set using the properties of TBlobField, or using a TIBBlobStream object, Modified is automatically set to True.


TIBBlobStream.Transaction

TIBBlobStream	See also

Gets or sets the associated transaction.

property Transaction: TIBTransaction;

Description

Use Transaction to set or read the associated transaction.


TIBBlobStream.TRHandle

TIBBlobStream	See also

Indicates the transaction handle.

property TRHandle: PISC_TR_HANDLE;

Description

Use TRHandle to obtain the transaction handle.


TIBBlobStream methods

TIBBlobStream	Alphabetically	Legend

In TIBBlobStream

Call

Cancel

CheckReadable

CheckWritable

Create

Destroy

Finalize

LoadFromFile

LoadFromStream

Read

SaveToFile

SaveToStream

Seek

SetSize

Truncate

Write

Derived from TStream

CopyFrom

FixupResourceHeader

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

WriteResourceHeader

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBBlobStream methods

TIBBlobStream	By object	Legend

AfterConstruction

BeforeDestruction

Call

Cancel

CheckReadable

CheckWritable

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Finalize

FixupResourceHeader

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

SaveToFile

SaveToStream

Seek

SetSize

Truncate

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

WriteResourceHeader


TIBBlobStream.Call

TIBBlobStream

Returns an error message based on the error code.

function Call(ISC_STATUS; RaiseError: Boolean): ISC_STATUS;

Description

Call is an internal method used to make calls to the InterBase API, and gives you the option of raising an exception or returning an error based on the value of RaiseError.


TIBBlobStream.Cancel

TIBBlobStream	See also

Cancels all changes to the BLOB field, reverting to its state when the Blob stream was created.

procedure Cancel;

Description

Call Cancel to back out all changes to the Blob field using this Blob stream. After a call to Cancel, the Modified property is reset to False.


TIBBlobStream.CheckReadable

TIBBlobStream	See also

Indicates whether or not a Blob is readable.

procedure CheckReadable;

Description

Call CheckReadable to determine whether or not a Blob is readable.  This method raises an exception if the Blob is not readable.


TIBBlobStream.CheckWritable

TIBBlobStream	See also

Indicates whether or not a Blob is write-able.

procedure CheckWritable;

Description

Call CheckWritable to determine whether or not a Blob is writeable. This method raises an exception if the Blob is not writeable.


TIBBlobStream.Create

TIBBlobStream	See also 	Example

Creates an instance of TIBBlobStream.

constructor Create;

Description

Call Create to obtain an instance of TIBBlobStream for reading from or writing to a specific TBlobField object.


TIBBlobStream.Destroy

TIBBlobStream	See also

Destroys an instance of TIBBlobStream.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead call Free. Free verifies that the TIBBlobStream object is not already freed and only then calls Destroy.

Destroy the TIBBlobStream object by calling Free when it is no longer needed for reading from or writing to the BLOB field.

Destroy triggers an OnDataChange event if the Blob stream was used to overwrite or modify the data in the field. Destroy then frees any buffers that were allocated to handle the data.


TIBBlobStream.Finalize

TIBBlobStream

Creates a Blob on the InterBase server and writes the data from the BlobStream to it.

procedure Finalize;

Description

Finalize creates a Blob on the InterBase server and writes the data from the BlobStream to the Blob and then closes the Blob.


TIBBlobStream.LoadFromFile

TIBBlobStream	See also

Loads a Blob from a file to the field.

procedure LoadFromFile(Filename: String);

Description

Use LoadFromFile to load the contents of a file into a Blob field. Specify the name of the file to load into the field as the value of the FileName parameter.


TIBBlobStream.LoadFromStream

TIBBlobStream	See also

Loads a Blob from a stream into the field.

procedure LoadFromStream(Stream: TStream);

Description

Use LoadFromStream to copy the contents of a stream into the Blob field. Specify the stream from which the field’s value is copied as the value of the Stream parameter.


TIBBlobStream.Read

TIBBlobStream	See also

Reads up to Count bytes from the current position in the field’s data into Buffer.

function Read(var Buffer; Count: Longint): Longint;

Description

Call Read to read data from the Blob field when the number of bytes in the field’s data is not known. Buffer must have at least Count bytes allocated to hold the data that was read from the field.

Read transfers up to Count bytes from the Blob data into Buffer, starting in the current position, and then advances the current position by the number of bytes actually transferred. Read returns the number of bytes actually transferred (which may be less than the number requested in Count.)

Read checks the Transliterate property of the field, and converts the data into ANSI from the character set specified by the dataset if Transliterate is True.

All the other data-reading methods of a Blob stream (ReadBuffer, ReadComponent) call Read to do their actual reading.

Note:	Do not call Read when the TIBBlobStream was created in bmWrite mode.


TIBBlobStream.SaveToFile

TIBBlobStream	See also

Saves the contents of the Blob field to a file.

procedure SaveToFile(FileName: string);

Description

Use SaveToFile to save the contents of the Blob field to a file. Specify the name of the file as the value of the FileName parameter.


TIBBlobStream.SaveToStream

TIBBlobStream	See also

Saves the contents of the BLOB field to a stream.

procedure SaveToStream(Stream: TStream);

Description

Use SaveToStream to copy the contents of a Blob field to a stream. Specify the name of the stream to which the field’s value is saved as the value of the Stream parameter.


TIBBlobStream.Seek

TIBBlobStream	See also

Resets the current position of the TIBBlobStream object.

function Seek(Offset: Longint; Origin: Word): Longint;

Description

Use Seek to move the current position within the Blob data by the indicated offset. Seek allows an application to read from or write to a particular location within the Blob data.

The Origin parameter indicates how to interpret the Offset parameter. Origin should be one of the following values:

Value	Meaning
soFromBeginning	Offset is from the beginning of the Blob data Seek moves to the position Offset Offset must be >= 0
soFromCurrent	Offset is from the current position in the Blob data Seek moves to Position + Offset
soFromEnd	Offset is from the end of the Blob data Offset must be <= 0 to indicate a number of bytes before the end of the Blob
Seek returns the new value of the Position property, the new current position in the Blob data.


TIBBlobStream.SetSize

TIBBlobStream	See also

Set the new total size of the Blob.

procedure SetSize(NewSize: Long);

Description

Call SetSize to set the new total size of the Blob.


TIBBlobStream.Truncate

TIBBlobStream	See also

Discards all data in the Blob field from the current position on.

procedure Truncate;

Description

Use Truncate to limit the size of the Blob data. Calling Truncate when the current position is 0 will clear the contents of the Blob field.

Note:	Do not call Truncate when the TIBBlobStream was created in bmRead mode.


TIBBlobStream.Write

TIBBlobStream	See also

Writes Count bytes from Buffer to the current position in the field and updates the current position by Count bytes.

function Write(const Buffer; Count: Longint): Longint;

Description

Use Write to write Count bytes to the Blob field, starting at the current position. The Write method for TIBBlobStream always writes the entire Count bytes, as Blob data does not necessarily include a termination character. Thus, Write is equivalent to the WriteBuffer method.

Write checks the Transliterate property of the field, and converts the data from ANSI into the character set of the dataset if Transliterate is True.

All the other data-writing methods of a Blob stream (WriteBuffer, WriteComponent) call Write to do their actual writing.

Note:	Do not call Write when the TIBBlobStream was created in bmRead mode.


Hierarchy

TObject

TStream

TIBBlobStream


 TIBClientDataSet

Hierarchy	Properties	Methods	Events	Using TIBClientDataSet	See also

TIBClientDataSet caches updates for data fetched using InterBase Express.

Unit

Description

TIBClientDataSet is a client dataset that uses an internal TIBDataSet and TDataSetProvider for fetching data and applying updates. It allows you to cache updates fetched using InterBase Expres without using an external provider and client dataset.

Caching updates using TIBClientDataSet (or an InterBase Express dataset with an external provider and client dataset) provide many benefits other than those that result from caching updates. These include:

You can use TIBClientDataSet to work with data stored in files on disk as well as with data fetched from a database server. This allows you to implement a “briefcase model” style application.

You can take advantage of features unique to client datasets such as maintained aggregates, filter support, and ranges.

Your application can be converted more easily to or from one that uses a different data access mechanism, by leveraging the similarities between TIBClientDataSet and other client datasets such as TSQLClientDataSet and TBDEClientDataSet.

TIBClientDataSet works like TClientDataSet when it is connected to a local TIBDataSet via a provider, except that the source dataset and provider are internal. It surfaces some of the properties and events of TIBDataSet and TDataSetProvider so that you can specify the database server from which to fetch data, indicate what data to fetch from that server, influence what information is included in data packets, and provide input on the updating process.

In addition to using the source TIBDataSet, TIBClientDataSet can read from and write to a dedicated file on disk. The internal provider and source dataset are not needed for working with file-based data, making TClientDataSet a more suitable choice if you are writing a purely file-based application. However, the ability to work with a file on disk makes TIBClientDataSet well-suited to “briefcase model” applications.


TIBClientDataSet properties

TIBClientDataSet	Alphabetically	Legend

In TIBClientDataSet

CommandText

DBConnection

DBTransaction

Derived from TCustomCachedDataSet

Active

Options

UpdateMode

Derived from TCustomClientDataSet

ActiveAggs

Aggregates

AggregatesActive

AppServer

CanModify

ChangeCount

CloneSource

Data

DataSetField

DataSize

DataSource

Delta

DisableStringTrim

FetchOnDemand

FileName

Filter

GroupingLevel

HasAppServer

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexName

KeyExclusive

KeyFieldCount

KeySize

LogChanges

MasterFields

MasterSource

PacketRecords

Params

ReadOnly

RecNo

RecordCount

RecordSize

SavePoint

StatusFilter

XMLData

Derived from TDataSet

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

Constraints

DefaultFields

Designer

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filtered

FilterOptions

Found

IsUniDirectional

Modified

Name

ObjectView

SparseArrays

State

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TIBClientDataSet properties

TIBClientDataSet	By object	Legend

Active

ActiveAggs

AggFields

Aggregates

AggregatesActive

AppServer

AutoCalcFields

BlockReadSize

Bof

Bookmark

CanModify

ChangeCount

CloneSource

CommandText

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constraints

Data

DataSetField

DataSize

DataSource

DBConnection

DBTransaction

DefaultFields

Delta

Designer

DesignInfo

DisableStringTrim

Eof

FetchOnDemand

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

FileName

Filter

Filtered

FilterOptions

Found

GroupingLevel

HasAppServer

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexName

IsUniDirectional

KeyExclusive

KeyFieldCount

KeySize

LogChanges

MasterFields

MasterSource

Modified

Name

ObjectView

Options

Owner

PacketRecords

Params

ReadOnly

RecNo

RecordCount

RecordSize

SavePoint

SparseArrays

State

StatusFilter

Tag

UpdateMode

VCLComObject

XMLData


TIBClientDataSet.CommandText

TIBClientDataSet	See also

Specifies what data to fetch from the database server.

property CommandText: string;

Description

CommandText is used to get or set the query that the internal TIBDataSet component uses to fetch its data. This is the same as the text of the internal dataset’s SelectSQL property.

If CommandText is an SQL statement that includes parameters or the name of a stored procedure that has parameters, use the Params property to supply parameter values.

Note:	If the FileName property is set, CommandText is ignored and the data is fetched from the specified file.

Warning:	Do not remove poAllowCommandText from the Options property. If you do, the value of CommandText will be ignored.


TIBClientDataSet.DBConnection

TIBClientDataSet	See also

Identifies the TIBDatabase component that connects the dataset to a database server.

property DBConnection: TIBDatabase;

Description

Use DBConnection to specify the component that connects this dataset to a database server.


TIBClientDataSet.DBTransaction

TIBClientDataSet	See also

Specifies the transaction object that manages the transactions this dataset uses.

property DBTransaction: TIBTransaction;

Description

Every command that the TIBClientDataSet component executes on the server occurs within the context of the specified transaction. Set DBTransaction to specify the properties of the transaction that this dataset uses. Use the methods of DBTransaction to explicitly control the transaction.

If DBTransaction is not set, this dataset uses the default transaction of the database specified by DBConnection.


TIBClientDataSet events

TIBClientDataSet	Alphabetically	Legend

Derived from TCustomCachedDataSet

AfterUpdateRecord

BeforeUpdateRecord

OnGetTableName

OnUpdateData

OnUpdateError

Derived from TCustomClientDataSet

AfterApplyUpdates

AfterExecute

AfterGetParams

AfterGetRecords

AfterRowRequest

BeforeApplyUpdates

BeforeExecute

BeforeGetParams

BeforeGetRecords

BeforeRowRequest

OnReconcileError

Derived from TDataSet

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TIBClientDataSet events

TIBClientDataSet	By object	Legend

AfterApplyUpdates

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterExecute

AfterGetParams

AfterGetRecords

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterRowRequest

AfterScroll

AfterUpdateRecord

BeforeApplyUpdates

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeExecute

BeforeGetParams

BeforeGetRecords

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeRowRequest

BeforeScroll

BeforeUpdateRecord

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnGetTableName

OnNewRecord

OnPostError

OnReconcileError

OnUpdateData

OnUpdateError


TIBClientDataSet methods

TIBClientDataSet	Alphabetically	Legend

In TIBClientDataSet

CloneCursor

Create

Destroy

GetQuoteChar

Derived from TCustomClientDataSet

AddIndex

AppendData

ApplyRange

ApplyUpdates

BookmarkValid

Cancel

CancelRange

CancelUpdates

CompareBookmarks

ConstraintsDisabled

CreateBlobStream

CreateDataSet

DataRequest

DeleteIndex

DisableConstraints

EditKey

EditRangeEnd

EditRangeStart

EmptyDataSet

EnableConstraints

Execute

FetchBlobs

FetchDetails

FetchParams

FindKey

FindNearest

GetCurrentRecord

GetGroupState

GetIndexInfo

GetIndexNames

GetNextPacket

GetOptionalParam

GotoCurrent

GotoKey

GotoNearest

LoadFromFile

LoadFromStream

Locate

Lookup

MergeChangeLog

Reconcile

RefreshRecord

RevertRecord

SaveToFile

SaveToStream

SetAltRecBuffers

SetKey

SetOptionalParam

SetProvider

SetRange

SetRangeEnd

SetRangeStart

UndoLastChange

UpdateStatus

Derived from TDataSet

ActiveBuffer

Append

AppendRecord

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBlobFieldData

GetBookmark

GetDetailDataSets

GetDetailLinkFields

GetFieldData

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

IsSequenced

Last

MoveBy

Next

Open

Post

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBClientDataSet methods

TIBClientDataSet	By object	Legend

ActiveBuffer

AddIndex

AfterConstruction

Append

AppendData

AppendRecord

ApplyRange

ApplyUpdates

Assign

BeforeDestruction

BookmarkValid

Cancel

CancelRange

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

CloneCursor

Close

CompareBookmarks

ConstraintsDisabled

ControlsDisabled

Create

CreateBlobStream

CreateDataSet

CursorPosChanged

DataRequest

DefaultHandler

Delete

DeleteIndex

Destroy

DestroyComponents

Destroying

DisableConstraints

DisableControls

Dispatch

Edit

EditKey

EditRangeEnd

EditRangeStart

EmptyDataSet

EnableConstraints

EnableControls

Execute

ExecuteAction

FetchBlobs

FetchDetails

FetchParams

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindKey

FindLast

FindNearest

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBlobFieldData

GetBookmark

GetCurrentRecord

GetDetailDataSets

GetDetailLinkFields

GetFieldData

GetFieldList

GetFieldNames

GetGroupState

GetIndexInfo

GetIndexNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextPacket

GetOptionalParam

GetParentComponent

GetQuoteChar

GotoBookmark

GotoCurrent

GotoKey

GotoNearest

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsImplementorOf

IsLinkedTo

IsSequenced

Last

LoadFromFile

LoadFromStream

Locate

Lookup

MergeChangeLog

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

Post

Prior

Reconcile

ReferenceInterface

Refresh

RefreshRecord

RemoveComponent

RemoveFreeNotification

Resync

RevertRecord

SafeCallException

SaveToFile

SaveToStream

SetAltRecBuffers

SetFields

SetKey

SetOptionalParam

SetProvider

SetRange

SetRangeEnd

SetRangeStart

SetSubComponent

Translate

UndoLastChange

UpdateAction

UpdateCursorPos

UpdateRecord

UpdateStatus


TIBClientDataSet.Create

TIBClientDataSet	See also

Creates and initializes an instance of TIBClientDataSet.

constructor Create(AOwner: TComponent); override;

Description

Call Create to create TIBClientDataSet at runtime. Datasets added to forms or data modules at design time are created automatically.

AOwner is the component that is responsible for freeing the TIBClientDataSet instance. If AOwner is nil, the application must explicitly free the dataset.

Create creates the internal source dataset and provider that fetch data from the database server and apply updates back to the database server.


TIBClientDataSet.Destroy

TIBClientDataSet	See also

Destroys the instance of TIBClientDataSet.

Description

Do not call Destroy directly in an application. Usually destruction of datasets is handled automatically. If an application creates its own instances of a dataset without assigning an Owner, however, it should call Free, which verifies that the dataset component is not nil before calling Destroy.


TIBClientDataSet.CloneCursor

TIBClientDataSet	See also

Shares the data belonging to another client dataset.

procedure CloneCursor(Source :TCustomClientDataSet; Reset: Boolean; KeepSettings: Boolean = False); virtual;

Description

Call CloneCursor to share the data belonging to another IB client dataset.

Source indicates another TIBClientDataSet whose data is to be shared. If Source specifies any other type of client dataset, CloneCursor raises an exception.

Reset and KeepSettings determine how to set the values of the following properties and events:

Filter, Filtered, FilterOptions, and OnFilterRecord

IndexName

MasterSource and MasterFields

ReadOnly

RemoteServer and ProviderName

If Reset and KeepSettings are both False, the values of the properties listed above are all set to match the source dataset.

If Reset is True, the properties listed above are all cleared.

If Reset is False and KeepSettings is True, the properties listed above are not changed. In this case, the application must ensure that existing indexes, providers, and so on are compatible with the cloned data.

After calling CloneCursor, the data for the client dataset is the same as the data for Source. Edits performed by either client dataset are reflected in the data of both datasets.

Note:	Because cloned cursors are shared, changing properties that affect the cursor affect both datasets. For example, setting the ReadOnly property of either dataset will make both datasets read-only.


TIBClientDataSet.GetQuoteChar

TIBClientDataSet	See also

Returns the character or characters to use in generated SQL statements to enclose quoted strings.

function GetQuoteChar: string;

Description

GetQuoteChar returns the character or characters that delimit quoted strings in SQL statements. This string appears both before and after quoted strings.

This string is used for the automatically-generated statements that apply updates. Use this string in the SQL statements you create for the CommandText property.

Note:	If the SQLDialect property of the database is not 3, it is not necessary to put quotes in SQL statements.


Hierarchy

TObject

TPersistent

TComponent

TDataSet

TCustomClientDataSet

TCustomCachedDataSet

TIBClientDataSet


 TIBConfigService

Hierarchy	Properties	Methods	Events	See also

TIBConfigService configures the database parameters

Unit

IBServices

Description

Use a TIBConfigService object to configure database parameters.

Note:	You must install InterBase 6 to use this feature.


TIBConfigService properties

TIBConfigService	Alphabetically	Legend

In TIBConfigService

DatabaseName

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBConfigService properties

TIBConfigService	By object	Legend

Active

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DatabaseName

DesignInfo

Handle

IsServiceRunning

LoginPrompt

Name

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject


TIBConfigService.DatabaseName

TIBConfigService	See also

Sets or returns the database name.

property DatabaseName: String;

Use DatabaseName to set or return the database name to set properties on.

Note: You must install InterBase 6 to use this feature.


TIBConfigService events

TIBConfigService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBConfigService events

TIBConfigService	By object	Legend

OnAttach

OnLogin


TIBConfigService methods

TIBConfigService	Alphabetically	Legend

In TIBConfigService

ActivateShadow

BringDatabaseOnline

ServiceStart

SetAsyncMode

SetDBSqlDialect

SetPageBuffers

SetReadOnly

SetReserveSpace

SetSweepInterval

ShutdownDatabase

Derived from TIBCustomService

Attach

Create

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBConfigService methods

TIBConfigService	By object	Legend

ActivateShadow

AfterConstruction

Assign

Attach

BeforeDestruction

BringDatabaseOnline

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetAsyncMode

SetDBSqlDialect

SetPageBuffers

SetReadOnly

SetReserveSpace

SetSubComponent

SetSweepInterval

ShutdownDatabase

UpdateAction!AL(tcomponent_updateaction, 1,,main)


TIBConfigService.ActivateShadow

TIBConfigService 	Example

Activates the shadow file for database use.

procedure ActivateShadow;

Description

Call ActivateShadow to activate the database shadow.

InterBase 6 lets you recover a database in case of disk failure, network failure, or accidental deletion of the database. This recovery method is known as disk shadowing, or simply shadowing. Before you can activate shadowing, you must first create a database shadow, as discussed in “Shadowing” and “Creating a shadow” in the InterBase 6 Operations Guide.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.BringDatabaseOnline

TIBConfigService	See also 	Example

Brings the database online.

procedure BringDatabaseOnline;

Description

Call BringDatabaseOnline to bring a database online.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.ServiceStart

TIBConfigService	See also

Not used for TIBConfigService

procedure ServiceStart;

Description

Do not use ServiceStart. TIBConfigService does not currently use this method.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.SetAsyncMode

TIBConfigService 	Example

Sets database writes to asynchronous mode.

procedure SetAsyncMode(Value: Boolean);

Description

Set SetAsyncMode to True to change the database write mode to asynchronous (buffered writes).

InterBase 6 allows you to write to databases in both synchronous and asynchronous modes. In synchronous mode, the database writes are forced. In asynchronous mode, the database writes are buffered.

For more information, refer to “Forced writes vs. buffered writes” in the InterBase 6 Operations Guide.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.SetDBSqlDialect

TIBConfigService 	Example

Sets the SQL dialect for the database.

procedureTIBConfigService.SetDBSqlDialect(Value: Integer);

Description

Call SetDBSqlDialect to set the SQL dialect for the database.  Valid integer values are 1, 2, and 3.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.SetPageBuffers

TIBConfigService	See also 	Example

Sets the number of database page buffers.

procedure SetPageBuffers (Value: Integer);

Description

Call SetPageBuffers to set the number of database page buffers.

When a program establishes a connection to a database, InterBase allocates system memory to use as a private buffer. The buffers are used to store accessed database pages to speed performance. The number of buffers assigned for a program determine how many simultaneous database pages it can have access to in the memory pool. Buffers remain assigned until a program finishes with a database.

For more information on page buffers, refer to “Setting database cache buffers” in the InterBase 6 Programmer’s Guide.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.SetReadOnly

TIBConfigService 	Example

Sets the database to read only.

procedure SetReadonly(Value: Boolean);

Description

Call SetReadOnly to set the database to read only.

Access mode specifies the type of access a transaction has for the table it uses. There are two possible modes: read-only and read-write.

•	Read-only specifies that a transaction can read data from a table, but cannot insert, update, or delete table data.

•	Read-write specifies that a transaction can select, insert, update, and delete table data. This is the default setting if none is specified.

Tip: It is good programming practice to specify the transaction’s access mode, even if is read-write. It makes the application’s source code easier to read and debug, because the program’s intentions are clearly spelled out.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.SetReserveSpace

TIBConfigService 	Example

Sets reserve space on the data page for versioning.

procedure SetReserveSpace(Value: Boolean);

Description

Set SetReserveSpace to True to reserve space on the data page for versioning.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.SetSweepInterval

TIBConfigService 	Example

Sets the sweep interval.

procedure SetSweepInterval(Value: Integer);

Description

Call SetSweepInterval set the sweep interval for the database. The sweep interval refers to the number of transactions between database sweeps.

To turn off database sweeps, set the sweep interval to 0.

Sweeping a database is a systematic way of removing outdated records from the database. Periodic sweeping keeps the database from getting too large. However, sweeping can also slow performance. For more information, refer to “Setting the sweep interval” in the InterBase 6 Operations Guide.

Note: You must install InterBase 6 to use this feature.


TIBConfigService.ShutdownDatabase

TIBConfigService	See also 	Example

Shuts down the database.

type TShutdownMode = set of (Forced, DenyTransaction, DenyAttachment);

procedure ShutdownDatabase(Options: TShutdownMode; Wait: Integer);

Description

Call ShutdownDatabase to shut down the database after a specified number of seconds.  TShutdownMode values are:

Forced	Shut down the database after the specified number of seconds.  To shut down the database immediately, set the number of seconds to 0.
DenyTransaction	Deny new transactions for the specified number of seconds and then shut down.  The shutdown will fail if there are still active transactions to the database.
DenyAttachment	Deny new attachments for the specified number of seconds and then shut down.  The shutdown will fail if there are still active attachments to the database.
Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBConfigService


 TIBControlAndQueryService

Hierarchy	Properties	Methods 	Events	See also

TIBControlAndQueryService is the ancestor object from which the log, statistical, validation, security, and backup and restore IBService components descend.

Unit

IBServices

Description

TIBControlAndQueryService is the ancestor object from which the log, statistical, validation, security, and backup and restore IBService components descend.  The service is unstructured because the output is in an unformatted text file.

Note: You must install InterBase 6 to use this feature.


TIBControlAndQueryService properties

TIBControlAndQueryService	Alphabetically	Legend

In TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBControlAndQueryService properties

TIBControlAndQueryService	By object	Legend

Active

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Eof

Handle

IsServiceRunning

LoginPrompt

Name

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject


TIBControlAndQueryService.BufferSize

TIBControlAndQueryService	See also

Sets or returns the buffer size.

property BufferSize;

Description

Use the BufferSize property to set or return the buffer size.

Note: You must install InterBase 6 to use this feature.


TIBControlAndQueryService.Eof

TIBControlAndQueryService	See also

Indicates that the end of file.

property Eof: Boolean;

Description

Use the Eof property indicate that the end of the file has been reached.

Note: You must install InterBase 6 to use this feature.


TIBControlAndQueryService events

TIBCustomService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBControlAndQueryService events

TIBCustomService	By object	Legend

OnAttach

OnLogin


TIBControlAndQueryService methods

TIBControlAndQueryService	Alphabetically	Legend

In TIBControlAndQueryService

Create

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBControlAndQueryService methods

TIBControlAndQueryService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


TIBControlAndQueryService.Create

TIBControlAndQueryService	See also

Creates an instance of a TIBControlAndQueryService.

constructor Create(AOwner:TComponent);

Description

Call Create to create an instance of a TIBControlAndQueryService component.

Note: You must install InterBase 6 to use this feature.


TIBControlAndQueryService.GetNextChunk

TIBControlAndQueryService	See also

Gets the next chunk of data.

function GetNextChunk: String;

Description

Call GetNextChunk to get the next chunk of data.

Note: You must install InterBase 6 to use this feature.


TIBControlAndQueryService.GetNextLine

TIBControlAndQueryService	See also

Starts the service.

function GetNextLine: String;

Description

Call GetNextLine to get the next line of data.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService


 TIBControlService

Hierarchy	Properties	Methods 	Events	See also

TIBControlService is the ancestor object from which the structured and unstructured IBService components descend.

Unit

IBServices

Description

TIBControlService is the ancestor object from which the structured and unstructured IBService components descend.

Note: You must install InterBase 6 to use this feature.


TIBControlService properties

TIBControlService	Alphabetically	Legend

In TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBControlService properties

TIBControlService	By object	Legend

Active

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Handle

IsServiceRunning

LoginPrompt

Name

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject


TIBControlService.IsServiceRunning

TIBControlService	See also

Indicates whether the service is running.

property IsServiceRunning: Boolean;

Description

Use the IsServiceRunning property to check whether the service is running.

Note: You must install InterBase 6 to use this feature.


TIBControlService events

TIBCustomService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBControlService events

TIBCustomService	By object	Legend

OnAttach

OnLogin


TIBControlService methods

TIBControlService	Alphabetically	Legend

In TIBControlService

Create

ServiceStart

Derived from TIBCustomService

Attach

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBControlService methods

TIBControlService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


TIBControlService.Create

TIBControlService	See also

Creates an instance of TIBControlService

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBControlService.

Note: You must install InterBase 6 to use this feature.


TIBControlService.ServiceStart

TIBControlService	See also

Starts the service.

procedure ServiceStart;

Description

Call ServiceStart to start the service.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService


TIBCustomSQLMonitor

Hierarchy	Properties	Methods	See also

TIBCustomSQLMonitor is the ancestor for TIBSQLMonitor.

Unit

IBSQLMonitor

Description

TIBCustomSQLMonitor is the ancestor object from which TIBSQLMonitor is derived.


TIBCustomSQLMonitor properties

TIBCustomSQLMonitor	Alphabetically	Legend

In TIBCustomSQLMonitor

Enabled

Handle

TraceFlags

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBCustomSQLMonitor properties

TIBCustomSQLMonitor	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Enabled

Handle

Name

Owner

Tag

TraceFlags

VCLComObject


TIBCustomSQLMonitor.Enabled

TIBCustomSQLMonitor	See also

Indicates whether the IB SQL monitor is actively monitoring communication with the server.

property Enabled: Boolean;

Description

Use Enabled to turn the SQL monitor on and off. When Enabled is True, the SQL monitor receives an OnSQL event for every database operation specified by the TraceFlags property. When Enabled is False, the SQL monitor does not receive any events.


TIBCustomSQLMonitor.Handle

TIBCustomSQLMonitor

Specifies the window handle that the SQL monitor uses to receive asynchronous messages.

property Handle: HWND;

Description

The database operations that trigger OnSQL events are monitored by a separate thread of execution. When that thread detects a relevant database operation, it sends a Windows message to the window identified by this Handle.


TIBCustomSQLMonitor.TraceFlags

TIBCustomSQLMonitor	See also

Inidcates which database operations are tracked.

type

  TTraceFlag = (tfQPrepare, tfQExecute, tfQFetch, tfError, tfStmt, tfConnect, tfTransact, tfBlob, tfService, tfMisc);

  TTraceFlags = set of TTraceFlag;

property TraceFlags: TTraceFlags;

Description

Use TraceFlags to specify which database operations the SQL Monitor should track in an application at runtime. TraceFlags enables performance tuning and SQL debugging when working with remote SQL database servers.

Note:	Normally trace options are set from the SQL Monitor rather than setting TraceFlags in application code.


TIBCustomSQLMonitor events

TIBCustomSQLMonitor	Alphabetically	Legend

In TIBCustomSQLMonitor

OnSQL


TIBCustomSQLMonitor events

TIBCustomSQLMonitor	By object	Legend

OnSQL


TIBCustomSQLMonitor.OnSQL

TIBCustomSQLMonitor	See also

Reports dynamic SQL activity on InterBase applications.

type TSQLEvent = procedure (EventText: string; EventTime: TDateTime) of object;

property OnSQL: TSQLEvent;

Description

Write an OnSQL event handler to report dynamic SQL activity on InterBase applications.

EventText is the text of the SQL command that triggered this event.

EventTime indicates the time when the command passed to or from the InterBase server.

Note:	You must enable the TraceFlags in each TIBDatabase component in order for the SQL monitor to receive status information from each database connection.


TIBCustomSQLMonitor methods

TIBCustomSQLMonitor	Alphabetically 	Legend

In TIBCustomSQLMonitor

Create

Destroy

Release

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBCustomSQLMonitor methods

TIBCustomSQLMonitor	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

Release

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction


TIBCustomSQLMonitor.Create

TIBCustomSQLMonitor	See also

Creates an instance of TIBCustomSQLMonitor.

constructor Create (AOwner: TComponent);

Description

Call Create to create an instance of TIBCustomSQLMonitor.  Create also:

Creates the window

Registers the event

Fires the Monitor thread


TIBCustomSQLMonitor.Destroy

TIBCustomSQLMonitor	See also

Destroys the instance of TIBCustomSQLMonitor.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the service object has not already been freed before it calls Destroy.

Destroy unregisters the event, destroys the window, and kills the Monitor thread.


TIBCustomSQLMonitor.Release

TIBCustomSQLMonitor	See also

Frees the helper objects that intercept database commands.

procedure Release;

Description

Call Release when the SQL monitor will not be monitoring any more messages. Release sends a message to the object that intercepts database commands, telling it to free itself.

To temporarily disable the monitor, use the Enabled property instead.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomSQLMonitor


TIBCustomService

Hierarchy	Properties	Methods	Events	See also

TIBCustomService is the ancestor object from which all IBService components descend.

Unit

IBServices

Description

TIBCustomService is the ancestor object from which all IBService components descend.


TIBCustomService properties

TIBCustomService	Alphabetically	Legend

In TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBCustomService properties

TIBCustomService	By object	Legend

Active

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Handle

LoginPrompt

Name

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject


TIBCustomService.Active

TIBCustomService

Sets the active state of the service.

property Active: Boolean;

Description

Use the Active property to set the service to active (True) or the default, inactive (False).


TIBCustomService.Handle

TIBCustomService	See also

Returns the database handle.

property Handle: TISC_SVC_HANDLE;

Description

Use the Handle property to return the database handle.


TIBCustomService.LoginPrompt

TIBCustomService	See also

Turns on and off login prompt display.

property LoginPrompt: Boolean;

Description

Use the LoginPrompt property to display (or not display) a login prompt before attaching to a database.


TIBCustomService.Params

TIBCustomService

Sets or returns the database parameters

property Params: TStrings;

Description

Use the Params property to set or return database parameters.


TIBCustomService.Protocol

TIBCustomService

Sets or returns the network protocol.

type TProtocol = set of (TCP, SPX, NamedPipe, Local);

property Protocol: TProtocol;

Use Protocol to select the network protocol, which can be one of:

Local
NamedPipe	Named pipe (FIFO)
SPX	IPX/SPX
TCP	Transport control protocol


TIBCustomService.ServerName

TIBCustomService

Sets the name of the server on which the services are to be run.

property ServerName: String;

Description

Use ServerName to set the name of the server on which the services are to be run.


TIBCustomService.ServiceParamBySPB

TIBCustomService

Returns and sets SPB parameters.

property ServiceParamBySPB[const Idx: Integer];

Description

Use ParamBySPB to inspect and set SPB parameters.

For example DBParamBySPB[isc_SPB_user_name] sets and inspects the user name.


TIBCustomService events

TIBCustomService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBCustomService events

TIBCustomService	By object	Legend

OnAttach

OnLogin


TIBCustomService.OnAttach

TIBCustomService	See also

Occurs when the database is attached.

property OnAttach: TNotifyEvent;

Description

Write an OnAttach event handler to take specific actions when a database is attached.  If an exception is raised in this event, the database is not attached.


TIBCustomService.OnLogin

TIBCustomService	See also

Occurs during database login.

property OnLogin: TNotifyEvent;

Description

Write an OnLogin event handler to take specific actions on database login.


TIBCustomService methods

TIBCustomService	Alphabetically	Legend

In TIBCustomService

Attach

Create

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBCustomService methods

TIBCustomService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction


TIBCustomService.Attach

TIBCustomService	See also

Attaches to the database.

procedure Attach;

Description

Call Attach to attach to the database.


TIBCustomService.Create

TIBCustomService	See also

Creates an instance of TIBCustomService

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBCustomService.


TIBCustomService.Destroy

TIBCustomService	See also

Destroys the service.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the service object has not already been freed before it calls Destroy.


TIBCustomService.Detach

TIBCustomService	See also

Detaches from the database.

procedure Detach;

Description

Call Detach to detach from the database.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService


 TIBCustomDataSet

Hierarchy	Properties	Methods	Events	See also

TIBCustomDataSet is the base class for all datasets that represent data fetched using InterBase Express.

Unit

IBCustomDataSet

Description

TIBCustomDataSet is a dataset object that defines InterBase Express (IBX) functionality for a dataset. Applications never use TIBCustomDataSet objects directly. Instead they use the descendants of TIBCustomDataSet, such as TIBDataSet, TIBQuery, TIBStoredProc, and TIBTable, which inherit its dataset-related properties and methods.


TIBCustomDataSet properties

TIBCustomDataSet	Alphabetically	Legend

In TIBCustomDataSet

BufferChunks

CachedUpdates

CanModify

Database

DataSource

DBHandle

DeleteSQL

ForcedRefresh

GeneratorField

InsertSQL

InternalPrepared

LiveMode

ModifySQL

ParamCheck

Params

Plan

QDelete

QInsert

QModify

QRefresh

QSelect

RecNo

RecordCount

RecordSize

RefreshSQL

RowsAffected

SelectSQL

SelectStmtHandle

SQLParams

StatementType

Transaction

TRHandle

UniDirectional

UpdateMode

UpdateObject

UpdateRecordTypes

UpdatesPending

Derived fromTDataSet

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

DataSetField

DefaultFields

Designer

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

IsUniDirectional

Modified

Name

ObjectView

SparseArrays

State

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TIBCustomDataSet properties

TIBCustomDataSet	By object	Legend

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

BufferChunks

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DataSetField

DataSource

DBHandle

DefaultFields

DeleteSQL

Designer

DesignInfo

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

Filtered

FilterOptions

ForcedRefresh

Found

GeneratorField

InsertSQL

InternalPrepared

IsUniDirectional

LiveMode

Modified

ModifySQL

Name

ObjectView

Owner

ParamCheck

Params

Plan

QDelete

QInsert

QModify

QRefresh

QSelect

RecNo

RecordCount

RecordSize

RefreshSQL

RowsAffected

SelectSQL

SelectStmtHandle

SparseArrays

SQLParams

State

StatementType

Tag

Transaction

TRHandle

UniDirectional

UpdateMode

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TIBCustomDataSet.BufferChunks

TIBCustomDataSet	See also

Specifies the dataset buffer chunk size.

property BufferChunks: Integer;

Description

Use BufferChunks to get or set the number of records for which the dataset allocates buffer space at any time. When the dataset’s buffer is full, trying to fetch an additional record causes the dataset to reallocate the buffer so that it has enough memory to hold an additional BufferChunks records.

Note:	When Unidirectional is True, BufferChunks has no meaning.


TIBCustomDataSet.CachedUpdates

TIBCustomDataSet	See also

Specifies whether cached updates are enabled for a dataset.

property CachedUpdates: Boolean;

Description

CachedUpdates enables or disables the use of cached updates for a dataset. If CachedUpdates is True, cached updates are enabled. If CachedUpdates is False, cached updates are disabled.

When cached updates are enabled, updates to a dataset (such as posting changes, inserting new records, or deleting records), are stored in an internal cache on the client machine instead of being written directly to the dataset’s underlying database tables. When changes are complete, an application writes all cached changes to the database in the context of a single transaction.

Note:	Instead of using cached updates, applications can obtain the same benefits with greater control by using a client dataset.


TIBCustomDataSet.CanModify

TIBCustomDataSet	See also

Indicates whether the database underlying a dataset permits write access to data.

property CanModify: Boolean;

Description

TIBCustomDataSet and its descendant classes, such as TIBQuery, TIBStoredProc, and TIBTable, redeclare and reimplement CanModify to perform meaningful tests to determine whether a dataset has write access to data.


TIBCustomDataSet.Database

TIBCustomDataSet	See also

Identifies the database component for which this dataset represents one or more tables.

property Database: TIBDatabase;

Description

Use Database to access the properties, events, and methods of the database component associated with this dataset.


TIBCustomDataSet.DataSource

TIBCustomDataSet	See also

Represents the data source of another dataset that supplies values to the dataset.

property DataSource: TDataSource;

Description

Use DataSource to get the data source of another dataset.


TIBCustomDataSet.DBHandle

TIBCustomDataSet	See also

Specifies the database handle for the dataset.

property DBHandle: PISC_DB_HANDLE;

Description

Check DBHandle to determine the database handle for the dataset.


TIBCustomDataSet.DeleteSQL

TIBCustomDataSet	See also

Holds the SQL statement used to delete rows from the dataset.

property DeleteSQL: TStrings;

Description

Use DeleteSQL to delete rows in the dataset.


TIBCustomDataSet.ForcedRefresh

TIBCustomDataSet	See also

Specifies whether the dataset should refresh its data every time it posts a record.

property ForcedRefresh: Boolean;

Description

Set ForcedRefresh to True to force the dataset to refresh its data every time it posts a record. When ForcedRefresh is False (the default), the data is only refreshed when you call the Refresh method, or when the dataset needs to fetch the value of a default or internally calculated field.


TIBCustomDataSet.GeneratorField

TIBCustomDataSet	See also

Specifies whether the dataset should refresh its data every time it posts a record.

property GeneratorField: TIBGeneratorField;

Description

Use GeneratorField to specify a generator that automatically provides the value for one of the fields in the dataset. Use the properties of the TIBGeneratorField object to indicate which field’s value should be set and how that value should be calculated.

Warning:	Do not set the value of GeneratorField. To change the value of this property, change the properties of the TIBGeneratorField object that is the value of this property.


TIBCustomDataSet.InsertSQL

TIBCustomDataSet	See also

Holds the SQL statement used to insert rows into the dataset.

property InsertSQL: TStrings;

Description

Use InsertSQL to insert rows into the dataset.


TIBCustomDataSet.InternalPrepared

TIBCustomDataSet	See also

Indicates whether the dataset has prepared its queries for execution.

property InternalPrepared: Boolean;

Description

TIBCustomDataSet uses InternalPrepared internally to determine when it needs to prepare its set of queries for execution. The dataset checks InternalPrepared before executing a query, and prepares the query if InternalPrepared is False.


TIBCustomDataSet.LiveMode

TIBCustomDataSet	See also

Indicates what types of edits, if any, can be made to the data in the dataset.

type

  TLiveMode = (lmInsert, lmModify, lmDelete, lmRefresh);

  TLiveModes = set of TLiveMode;

property LiveMode: TLiveModes;

Description

Read LiveMode to determine what types of edits should be allowed. LiveMode is set automatically to restrict the capabilities of the dataset to reflect the user’s rights.

Livemode is a set that can contain zero or more of the following values:

Value	Meaning

lmInsert	The application can insert records.

lmModify	The application can modify existing records.

lmDelete	The application can delete records.

lmRefresh	The application can refresh the records in the dataset.

Note:	For read-only datasets, such as TIBQuery, LiveMode is always an empty set.


TIBCustomDataSet.ModifySQL

TIBCustomDataSet	See also

Provides the ability to access the SQL object encapsulating the ModifySQL statement.

property ModifySQL: TStrings;

Description

Use ModifySQL to access the SQL object that encapsulates the ModifySQL statement.


TIBCustomDataSet.ParamCheck

TIBCustomDataSet	See also

Specifies whether the parameter list for a query is regenerated if the SQL property changes at runtime.

property ParamCheck;

Description

Set ParamCheck to specify whether the Params property is cleared and regenerated if an application modifies the SQL in this dataset’s query. By default ParamCheck is True, meaning that the Params property is automatically regenerated at runtime. When ParamCheck is True, the proper number of parameters is guaranteed to be generated for the current SQL statement.

This property is useful for data definition language (DDL) statements that contain parameters as part of the DDL statement that are not parameters for the TIBCustomDataSet. For example, the DDL statement to create a stored procedure may contain parameter statements that are part of the stored procedure. Set ParamCheck to False to prevent these parameters from being mistaken for parameters of the TIBCustomDataSet executing the DDL statement.


TIBCustomDataSet.Params

TIBCustomDataSet	See also

Specifies the parameters to use for any parameterized queries.

property Params: TIBXSQLDA;

Description

Use Params to set up the parameters for the SQL object specified by the QSelect property. Params is the same as the SQLParams property.


TIBCustomDataSet.Plan

TIBCustomDataSet	See also

Indicates the PLAN portion of the dataset’s SELECT query.

property Plan: string;

Description

ReadPlan to determine the PLAN clause in the query specified by QSelect.


TIBCustomDataSet.QDelete

TIBCustomDataSet	See also

Provides the ability to directly access the SQL object encapsulating the DeleteSQL statement.

property QDelete: TIBSQL;

Description

Use QDelete to access the SQL object which encapsulates the Delete SQL statement.


TIBCustomDataSet.QInsert

TIBCustomDataSet	See also

Provides the ability to directly access the SQL object encapsulating the InsertSQL statement.

property QInsert: TIBSQL;

Description

Use QInsert to access the SQL object that encapsulates the InsertSQL statement.


TIBCustomDataSet.QModify

TIBCustomDataSet	See also

Provides the ability to directly access the SQL object encapsulating the ModifySQL statement.

property QModify: TIBSQL;

Description

Use QModify to access the SQL object that encapsulates the ModifySQL statement.


TIBCustomDataSet.QRefresh

TIBCustomDataSet	See also

Provides the ability to directly access the SQL object encapsulating the RefreshSQL statement.

property QRefresh: TIBSQL;

Description

Use QRefresh to access the SQL object that encapsulates the RefreshSQL statement.


TIBCustomDataSet.QSelect

TIBCustomDataSet	See also

Provides the ability to directly access the SQL object encapsulating the SelectSQL statement.

property QSelect: TIBSQL;

Description

Use QSelect to access the SQL object that encapsulates the SelectSQL statement.


TIBCustomDataSet.RecNo

TIBCustomDataSet 	See also

Indicates the active record in the dataset.

property RecNo: Integer;

Description

Examine RecNo to determine the record number of the current record in the dataset. Set RecNo to change the current record to a record specified by its sequential position.


TIBCustomDataSet.RecordCount

TIBCustomDataSet 	See also

Indicates the number of records currently fetched by the dataset.

property RecordCount: Integer;

Description

Examine RecordCount to determine the number of records that the dataset has currently retrieved from the server. As the dataset fetches records from the server, the value of RecordCount increases.

After a call to the FetchAll method, RecordCount is the total number of records in the dataset.


TIBCustomDataSet.RecordSize

TIBCustomDataSet 	See also

Indicates the size of a record in the dataset.

property RecordSize: Word;

Description

Examine RecordSize to determine the physical size, in bytes, of the buffer allocated to hold a record in the dataset. When a dataset is opened, the Open procedure requests record-buffer size information and stores the returned information in RecordSize. Client datasets use this information internally. Applications seldom, if ever, require this information.


TIBCustomDataSet.RefreshSQL

TIBCustomDataSet	See also

Provides the ability to directly access the SQL object encapsulating the RefreshSQL statement.

property RefreshSQL: TStrings;

Description

Use RefreshSQL to access the SQL object that encapsulates the RefreshSQL statement.


TIBCustomDataSet.RowsAffected

TIBCustomDataSet 	See also

Indicates the number of rows operated on by the latest query execution.

property RowsAffected: Integer;

Description

When the dataset represents a query that does not return a result set, you can’t use the RecordCount property to ascertain the number of records affected by the query. In such cases, read RowsAffected to determine how many rows were updated or deleted by the query when it executed. If no rows were updated or deleted, RowsAffected is zero. RowsAffected is –1 if the query could not be executed due to an error condition. (This latter situation typically follows the throwing of an exception.)


TIBCustomDataSet.SelectSQL

TIBCustomDataSet	See also

Provides the ability to directly access the SQL object encapsulating the SelectSQL statement.

property SelectSQL: TStrings;

Description

Use SelectSQL to access the SQL object that encapsulates the SelectSQL statement.


TIBCustomDataSet.SelectStmtHandle

TIBCustomDataSet 	See also

Gets the handle for the SELECT statement.

property SelectStmtHandle;

Description

Use SelectStmtHandle to get the handle for the SELECT statement.


TIBCustomDataSet.SQLParams

TIBCustomDataSet	See also

Specifies the parameters to use for any parameterized queries.

property SQLParams: TIBXSQLDA;

Description

Use SQLParams to set up the parameters for the SQL object specified by the QSelect property. SQLParams is the same as the Params property.


TIBCustomDataSet.StatementType

TIBCustomDataSet	See also

Returns the statement type of the QSelect query.

type TIBSQLTypes = set of (SQLUnknown, SQLSelect, SQLInsert, SQLUpdate, SQLDelete, SQLDDL, SQLGetSegment, SQLPutSegment, SQLExecProcedure, SQLStartTransaction, SQLCommit, SQLRollback, SQLSelectForUpdate, SQLSetGenerator);

property StatementType: TIBSQLTypes;

Description

Use StatementType to determine the statement type of a QSelect query.  TIBSQLTypes are:

SQLCommit	Commits an active transaction
SQLDDL	Executes a DDL statement
SQLDelete	Removes rows in a table or in the active set of a cursor
SQLExecProcedure	Calls a stored procedure
SQLGetSegment	Reads a segment from an open Blob
SQLInsert	Adds one or more new rows to a specified table
SQLPutSegment	Writes a Blob segment
SQLRollback	Restores the database to its state prior to the start of the current transaction
SQLSetForUpdate	Stored procedure is set for updating
SQLSetGenerator	Sets a new value for an existing generator
SQLSelect	Retrieves data from one or more tables
SQLStartTransaction	Starts a new transaction against one or more databases
SQLUnknown	Unknown SQL type
SQLUpdate	Changes data in all or part of an existing row in a table, view, or active set of a cursor


TIBCustomDataSet.Transaction

TIBCustomDataSet	See also

Identifies the transaction under which the query executes.

property Transaction: TIBTransaction;

Description

Use Transaction to determine the transaction that contains any query this dataset executes. Set the properties of this transaction object to control how the transaction executes, or set the Transaction property to cause this dataset’s queries to be included in an existing transaction.


TIBCustomDataSet.TRHandle

TIBCustomDataSet	See also

Specifies the transaction handle for the dataset.

property TRHandle: PISC_TR_HANDLE;

Description

Check TRHandle to determine the transaction handle for the dataset.


TIBCustomDataSet.UniDirectional

TIBCustomDataSet	See also

Determines whether bidirectional cursors are enabled for the dataset.

property UniDirectional: Boolean;

Description

Use UniDirectional to determine whether bidirectional cursors are enabled for this dataset.

Note:	Do not confuse the UniDirectional property with the IsUniDirectional property inherited from TDataSet. IsUniDirectional indicates whether the dataset is a dbExpress dataset, which, in addition to using a unidirectional cursor, does not buffer records. UniDirectional is only concerned with whether the cursor permits backward or random navigation.


TIBCustomDataSet.UpdateMode

TIBCustomDataSet	See also

Indicates how records are located when updating records.

property UpdateMode: TUpdateMode;

Description

UpdateMode is not currently implemented in IB datasets. It is reserved for future use.


TIBCustomDataSet.UpdateObject

TIBCustomDataSet	See also

Specifies the update object component used to update a read-only result set.

property UpdateObject: TIBDataSetUpdateObject;

Description

Use UpdateObject to specify the TIBDataSetUpdateObject component to use in an application that must be able to update a read-only result set.

In some cases, such as when using TIBQuery, the dataset does not automatically update records. In these cases, UpdateObject can be used to specify a TIBUpdateSQL component that performs updates as a separate transaction that is transparent to the application.

TIBDataSetUpdateObject is especially useful for complicated updates from an OnUpdateRecord event.


TIBCustomDataSet.UpdateRecordTypes

TIBCustomDataSet	See also 	Example

Specifies the type of records visible in a dataset when cached updates are enabled.

type TIBUpdateRecordTypes = set of (cusModified, cusInserted, cusDeleted, cusUnmodified, cusUninserted);

property UpdateRecordTypes: TIBUpdateRecordTypes;

Description

Use UpdateRecordTypes to specify the records that are visible in a dataset when cached updates are enabled. UpdateRecordTypes is a set that can have the following values:

Value	Meaning

cusModified	Modified records are visible.

cusInserted	Inserted records are visible.

cusDeleted	Deleted records are visible.

cusUnmodified	Unmodified records are visible.

cusUninserted	Uninserted records are visible.

By default, a dataset is created with an UpdateRecordTypes set of cusModified, cusInserted, or cusUnmodified, meaning that all existing, edited, or inserted records are visible to the user.

An application that must cycle through a dataset to undelete records may change UpdateRecordTypes as part of an undelete method, so that deleted records are “visible” long enough to restore them to their previously undeleted conditions.

Similarly, an application that must cycle through a dataset to uninsert records may change UpdateRecordTypes as part of an uninsert method, so that uninserted records are “visible” long enough to restore them to their previously inserted conditions.

An application might also use UpdateRecordTypes like a filter to temporarily limit visible records to those added or inserted by the user during the current session.


TIBCustomDataSet.UpdatesPending

TIBCustomDataSet	See also

Indicates whether the cached updates buffer contains records that are not yet applied.

property UpdatesPending: Boolean;

Description

Examine UpdatesPending to check the status of the cached updates buffer. If UpdatesPending is True, then there are edited, deleted, or inserted records to apply to the database. If UpdatesPending is False, there are no records in the cache.


TIBCustomDataSet events

TIBCustomDataSet	Alphabetically	Legend

In TIBCustomDataSet

AfterDatabaseDisconnect

AfterTransactionEnd

BeforeDatabaseDisconnect

BeforeTransactionEnd

DatabaseFree

OnUpdateError

OnUpdateRecord

TransactionFree

Derived from TDataSet

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TIBCustomDataSet events

TIBCustomDataSet	By object	Legend

AfterCancel

AfterClose

AfterDatabaseDisconnect

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

AfterTransactionEnd

BeforeCancel

BeforeClose

BeforeDatabaseDisconnect

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

BeforeTransactionEnd

DatabaseFree

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

AfterTransactionEnd

OnUpdateError

OnUpdateRecord

TransactionFree


TIBCustomDataSet.AfterDatabaseDisconnect

TIBCustomDataSet	See also

Occurs immediately after the connection to the associated database is closed.

property AfterDatabaseDisconnect: TNotifyEvent;

Description

Write an AfterDatabaseDisconnect event handler to respond when the dataset closes its connection to the database specified by the Database property.


TIBCustomDataSet.AfterTransactionEnd

TIBCustomDataSet	See also

Occurs immediately after a transaction that includes this dataset’s query ends.

property AfterTransactionEnd: TNotifyEvent;

Description

Write an AfterTransactionEnd event handler to respond when the transaction specified by the Transaction property ends.


TIBCustomDataSet.BeforeDatabaseDisconnect

TIBCustomDataSet	See also

Occurs immediately before the connection to the associated database is closed.

property BeforeDatabaseDisconnect: TNotifyEvent;

Description

Write a BeforeDatabaseDisconnect event handler to respond when the dataset is about to close its connection to the database specified by the Database property.


TIBCustomDataSet.BeforeTransactionEnd

TIBCustomDataSet	See also

Occurs immediately before a transaction that includes this dataset’s query ends.

property BeforeTransactionEnd: TNotifyEvent;

Description

Write a BeforeTransactionEnd event handler to respond when the transaction specified by the Transaction property is about to end.


TIBCustomDataSet.DatabaseFree

TIBCustomDataSet	See also

Occurs when the database associated with this dataset is freed.

property DatabaseFree: TNotifyEvent;

Description

Write a DatabaseFree event handler to respond when the database specified by the Database property is freed.


TIBCustomDataSet.OnUpdateError

TIBCustomDataSet	See also

Occurs if an exception is generated when cached updates are applied to a database.

type

  TIBUpdateAction = (uaFail, uaAbort, uaSkip, uaRetry, uaApplied, uaApply);

  TIBUpdateErrorEvent = procedure(DataSet: TDataSet; E: EDatabaseError; UpdateKind: TUpdateKind; var UpdateAction: TIBUpdateAction)of object;

property OnUpdateError: TIBUpdateErrorEvent;

Description

Write an OnUpdateError event handler to respond to exceptions generated when cached updates are applied to a database.

Because there is a delay between the time a record is first cached and the time cached updates are applied, there is a possibility that another application may change one or more of the same records in the database before the cached changes can be applied. DataSet is the name of the dataset to which updates are applied.

E is a pointer to an EDBEngineError object from which an application can extract an error message and the actual cause of the error condition. An OnUpdateError handler can use this information to determine how to respond to the error condition.

UpdateKind indicates whether the error occurred while inserting, deleting, or modifying a record.

UpdateAction indicates the action to take when the OnUpdateError handler exits. On entry into the handler, UpdateAction is always set to uaFail. If OnUpdateError can handle or correct the error, set UpdateAction to uaRetry before exiting the error handler. The following table lists the possible values for UpdateAction and what they indicate:

Value	Meaning

uaAbort	Aborts the update operation without Returning an error message

uaApply	For internal use only

uaApplied	Not used in error handling routines

uaFail	Aborts the update operation and returns an error message

uaRetry	Repeats the update operation that originally raised the error condition

uaSkip	Skips updating the record that raised the error condition, and leaves the unapplied changes in the cache

The error handler can use the TField.OldValue and TField.NewValue properties to evaluate error conditions and set TField.NewValue to a new value to reapply. In this case, set UpdateAction to uaRetry before exiting.

Note:	If a call to ApplyUpdates raises an exception and ApplyUpdates is not called within the context of a try..except block, an error message is Returned. If an OnUpdateError handler cannot correct the error condition and leaves UpdateAction set to uaFail, the error message is Returned twice. To prevent reReturn, set UpdateAction to uaAbort in the error handler.

Important:	The code in an OnUpdateError handler must not call any methods that make a different record the current one.


TIBCustomDataSet.OnUpdateRecord

TIBCustomDataSet	See also

Occurs when cached updates are applied to a record.

type

  TIBUpdateAction = (uaFail, uaAbort, uaSkip, uaRetry, uaApply, uaApplied);

  TIBUpdateRecordEvent = procedure(DataSet: TDataSet; UpdateKind: TUpdateKind; var UpdateAction: TIBUpdateAction) of object;

property OnUpdateRecord: TIBUpdateRecordEvent;

Description

Write an OnUpdateRecord event handler to process updates that cannot be handled by a single update component, such as implementation of cascading updates, insertions, or deletions. This handler is also useful for applications that require additional control over parameter substitution in update components.

DataSet is the name of the dataset to which updates are applied.

UpdateKind whether the current update is the insertion of a record, the deletion of a record, or the modification of a record.

UpdateAction indicates the action taken by the OnUpdateRecord handler before it exits. On entry into the handler, UpdateAction is always set to uaFail. If OnUpdateRecord is successful, it should set UpdateAction to uaApplied before exiting. The following table lists the possible values for UpdateAction and what they indicate:

Value	Meaning

uaAbort	Abort the update operation without Returning an error message.

uaApply	For internal use.

uaApplied	Update is applied. Free update record from cache.

uaFail	Aborts the update operation and Returns an error message.

uaRetry	Not used for record updates.

uaSkip	Update is skipped. Leave update record in the cache.

Note:	The code in an OnUpdateRecord handler must not call any methods that make a different record the current one.


TIBCustomDataSet.TransactionFree

TIBCustomDataSet	See also

Occurs when the transaction that includes this dataset’s query is freed.

property TransactionFree: TNotifyEvent;

Description

Write a TransactionFree event handler to respond when the transaction specified by the Transaction property is freed.


TIBCustomDataSet methods

TIBCustomDataSet	Alphabetically 	Legend

In TIBCustomDataSet

ApplyUpdates

BookmarkValid

CachedUpdateStatus

CancelUpdates

CompareBookmarks

Create

CreateBlobStream

Current

Destroy

FetchAll

GetCurrentRecord

GetFieldData

IsSequenced

Locate

LocateNext

Lookup

Post

RecordModified

RevertRecord

SQLType

Undelete

UpdateStatus

Derived from TDataSet

ActiveBuffer

Append

AppendRecord

Cancel

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBlobFieldData

GetBookmark

GetDetailDataSets

GetDetailLinkFields

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBCustomDataSet methods

TIBCustomDataSet	By object 	Legend

ActiveBuffer

AfterConstruction

Append

AppendRecord

ApplyUpdates

Assign

BeforeDestruction

BookmarkValid

CachedUpdateStatus

Cancel

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CompareBookmarks

ControlsDisabled

Create

CreateBlobStream

Current

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableControls

Dispatch

Edit

EnableControls

ExecuteAction

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBlobFieldData

GetBookmark

GetCurrentRecord

GetDetailDataSets

GetDetailLinkFields

GetFieldData

GetFieldList

GetFieldNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsImplementorOf

IsLinkedTo

IsSequenced

Last

Locate

LocateNext

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

Post

Prior

RecordModified

ReferenceInterface

Refresh

RemoveComponent

RemoveFreeNotification

Resync

RevertRecord

SafeCallException

SetFields

SetSubComponent

SQLType

Translate

Undelete

UpdateAction

UpdateCursorPos

UpdateRecord

UpdateStatus


TIBCustomDataSet.ApplyUpdates

TIBCustomDataSet	See also

Writes a dataset’s pending cached updates to the database.

procedure ApplyUpdates;

Description

Call ApplyUpdates to write a dataset’s pending cached updates to a database. This method passes cached data to the database for storage, but the changes are not committed to the database. An application must explicitly call the TIBTransaction component’s Commit method to commit the changes to the database if the write is successful, or call the TIBTransaction component’s Rollback method to undo the changes if there is an error.

Note:	The preferred method for updating datasets is to call a database component’s ApplyUpdates method rather than to call each individual dataset’s ApplyUpdates method. The application is responsible for committing or rolling back the transaction.


TIBCustomDataSet.BookmarkValid

TIBCustomDataSet	See also

Indicates the validity of a specified bookmark.

function BookmarkValid(Bookmark: TBookmark): Boolean; override;

Description

This function returns True if the specified bookmark can be used to identify a record in the dataset, False otherwise.


TIBCustomDataSet.CachedUpdateStatus

TIBCustomDataSet	See also

Returns the status of the cached updates.

type TCachedUpdateStatus = (cusUnmodified, cusModified, cusInserted, cusDeleted, cusUninserted);

function CachedUpdateStatus: TCachedUpdateStatus;

Description

Call CachedUpdateStatus to return the cached update status of the current record in the dataset.  TCachedUpdateStatus can be one of the following:

cusDeleted	Record will be deleted
cusInserted	Record will be inserted
cusModified	Record will be modified
cusUninserted	Record was inserted and then deleted
cusUnmodified	Record was not modified


TIBCustomDataSet.CancelUpdates

TIBCustomDataSet	See also

Clears all pending cached updates from the cache.

procedure CancelUpdates;

Description

Call CancelUpdates to clear all pending cached updates from the cache.

When a dataset is closed, or the CachedUpdates property is set to False, CancelUpdates is called automatically.

Note:	To undo changes to a single record, call RevertRecord.


TIBCustomDataSet.CompareBookmarks

TIBCustomDataSet

Compares two bookmarks.

function CompareBookmarks(Bookmark1, Bookmark2: TBookmark): Integer;

Description

Call CompareBookmarks to compare one bookmark to another. CompareBookmarks returns an integer value indicating the difference between the two bookmarks. CompareBookmarks returns a 0 (zero) if the two bookmarks are the same, a –1 (negative one) if bookmark one is less than bookmark two, or a 1 (positive one) if bookmark one is greater than bookmark two. CompareBookmarks also returns a zero if one of the two bookmarks is nil.

Bookmark1 and Bookmark2 are the two TBookmark values to compare.


TIBCustomDataSet.Create

TIBCustomDataSet	See also

Creates an instance of a TDataSet component.

constructor Create(AOwner: TComponent);

Description

Call Create to instantiate a dataset component at runtime. Ordinarily applications instantiate dataset descendants, such as TIBTable, TIBQuery, TIBDataSet, or TIBStoredProc, rather than TIBCustomDataSet. These instantiated objects are handled automatically.

On the other hand, applications that create specialized dataset components, such as custom components, may need to instantiate a TIBCustomDataSet component by calling Create. Create:

Calls the inherited Create for TDataSet.

Creates the five query objects.

Creates the base object to hold the reference to the database and transaction.

Associates database and transaction related events to the base object component.


TIBCustomDataSet.CreateBlobStream

TIBCustomDataSet	See also	Example

Returns a TIBDSBlobStream object for reading or writing the data in a specified blob field.

function CreateBlobStream(Field: TField; Mode: TBlobStreamMode): TStream; override;

Description

Call CreateBlobStream to obtain a stream for reading data from or writing data to a binary large object (BLOB) field. The Field parameter must specify a TBlobField component from the Fields property array. The Mode parameter specifies whether the stream will be used for reading, writing, or updating the contents of the field.

Note:	The stream that this method returns belongs to the dataset. Do not free the stream: the dataset handles all allocation and freeing of streams that this method creates.


TIBCustomDataSet.Current

TIBCustomDataSet	See also

Returns the descriptor area that holds information about the current query.

function Current: TIBXSQLDA;

Description

Most applications do not need to call the Current method. It returns the extended descriptor area for the dataset’s SQL statement, which can be used to retrieve properties of the SQL statement.


TIBCustomDataSet.Destroy

TIBCustomDataSet	See also

Destroys the instance of a dataset component.

destructor Destroy;

Description

Do not call Destroy directly in an application. Usually destruction of datasets is handled automatically by Delphi. If an application creates its own instances of a dataset, however, the application should call Free, which verifies that the dataset component is not already freed before calling Destroy.

Destroy performs the following tasks:

Frees the associated query objects.

Frees the base object.

Frees the associated internal resources.


TIBCustomDataSet.FetchAll

TIBCustomDataSet	See also

Retrieves all records from the current cursor position to the end of the file and stores them locally.

procedure FetchAll;

Description

Call FetchAll to reduce network traffic when using cached updates. FetchAll calls CheckBrowseMode to post any pending changes, and then retrieves all records from the current cursor position to the end of the file, and stores them locally. Ordinarily when cached updates are enabled, a transaction retrieves only as much data as it needs for return purposes.

Note:	Using FetchAll is not always appropriate. For example, when an application accesses a database used by many simultaneous clients and there is a high degree of contention for updating the same records, fetching all records at once may not be advantageous because some fetched records may be changed by other applications. Always weigh the advantages of reduced network traffic against the need for reduced record contention.


TIBCustomDataSet.GetCurrentRecord

TIBCustomDataSet	See also

Retrieves the current record into a buffer.

function GetCurrentRecord(Buffer: PChar): Boolean;

Description

Most applications should not need to call GetCurrentRecord. TDataSet automatically allocates a buffer for the active record.

Call GetCurrentRecord to copy the current record into a buffer allocated by the application. Buffer must be at least as big as the record size indicated by the RecordSize property.


TIBCustomDataSet.GetFieldData

TIBCustomDataSet

Reads the field data into a buffer.

function GetFieldData(FieldNo: Integer; Buffer: Pointer): Boolean; overload;

function GetFieldData(Field: TField; Buffer: Pointer): Boolean; overload; override;

function GetFieldData(Field: TField; Buffer: Pointer; NativeFormat: Boolean): Boolean; overload; override;

Description

Most applications do not need to call GetFieldData. TField objects call this method to implement their GetData method.

The Field or FieldNo parameter indicates the field whose data should be fetched. Field specifies the component itself, while FieldNo indicates its field number. The Buffer parameter is a memory buffer with sufficient space to accept the value of the field as it exists in the database (unformatted and untranslated). NativeFormat indicates whether the dataset fetches the field in Delphi’s native format for the field type. When NativeFormat is False, the dataset must convert the field value to the native type. This allows the field to handle data from different types of datasets (IBX, BDE-based, and so on) in a uniform manner.

GetFieldData returns True if the data was successfully written to Buffer.


TIBCustomDataSet.IsSequenced

TIBCustomDataSet	See also

IsSequenced indicates whether sequence numbers are available for database records.

function IsSequenced: Boolean; override;

Description

Call IsSequenced to determine whether database records can be located by sequence numbers. When IsSequenced is True, the dataset can navigate directly to a specific record by setting the RecNo property. If IsSequenced is False, the only way to navigate to a specific record is to start at the beginning and count records.


TIBCustomDataSet.Locate

TIBCustomDataSet	See also

Searches the dataset for a specified record and makes that record the current record.

function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean;

Description

Call Locate to search a dataset for a specific record and position the cursor on it.

KeyFields is a string containing a semicolon-delimited list of field names on which to search.

KeyValues is a variant that specifies the values to match in the key fields. If KeyFields lists a single field, KeyValues specifies the value for that field on the desired record. To specify multiple search values, pass a variant array as KeyValues, or construct a variant array on the fly using the VarArrayOf routine. For example:

with CustTable do

Locate('Company;Contact;Phone', VarArrayOf(['Sight Diver', 'P', '408-431-1000']), [loPartialKey]);

Options is a set that optionally specifies additional search latitude when searching on string fields. If Options contains the loCaseInsensitive setting, then Locate ignores case when matching fields. If Options contains the loPartialKey setting, then Locate allows partial-string matching on strings in KeyValues. If Options is an empty set, or if KeyFields does not include any string fields, Options is ignored.

Locate returns True if it finds a matching record, and makes that record the current one. Otherwise Locate returns False.

Locate uses the fastest possible method to locate matching records. If the search fields in KeyFields are indexed and the index is compatible with the specified search options, Locate uses the index. Otherwise Locate creates a filter for the search.


TIBCustomDataSet.LocateNext

TIBCustomDataSet	See also

Searches the dataset for the record after a specified record and makes that record the current record.

function LocateNext(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean;

Description

Call LocateNext to search a dataset for a record after the current cursor position

KeyFields is a string containing a semicolon-delimited list of field names on which to search.

KeyValues is a variant that specifies the values to match in the key fields. If KeyFields lists a single field, KeyValues specifies the value for that field on the desired record. To specify multiple search values, pass a variant array as KeyValues, or construct a variant array on the fly using the VarArrayOf routine.

Options is a set that optionally specifies additional search latitude when searching on string fields. If Options contains the loCaseInsensitive setting, then LocateNext ignores case when matching fields. If Options contains the loPartialKey setting, then LocateNext allows partial-string matching on strings in KeyValues. If Options is an empty set, or if KeyFields does not include any string fields, Options is ignored.

LocateNext returns True if it finds a matching record, and makes that record the current one. Otherwise LocateNext returns False.

LocateNext uses the fastest possible method to locate matching records. If the search fields in KeyFields are indexed and the index is compatible with the specified search options, LocateNext uses the index. Otherwise LocateNext creates a filter for the search.


TIBCustomDataSet.Lookup

TIBCustomDataSet	See also

Retrieves field values from a record that matches specified search values.

function Lookup(const KeyFields: string; const KeyValues: Variant; const ResultFields: string): Variant;

Description

Call Lookup to retrieve values for specified fields from a record that matches search criteria. KeyFields is a string containing a semicolon-delimited list of field names on which to search.

KeyValues is a variant array containing the values to match in the key fields. To specify multiple search values, pass KeyValues as a variant array as an argument, or construct a variant array on the fly using the VarArrayOf routine.

ResultFields is a string containing a semicolon-delimited list of field names whose values should be returned from the matching record.

Lookup returns a variant array containing the values from the fields specified in ResultFields.

Lookup uses the fastest possible method to locate matching records. If the search fields in KeyFields are indexed, Lookup uses the index. Otherwise Lookup creates a filter for the search.


TIBCustomDataSet.Post

TIBCustomDataSet	See also

Writes a modified record to the database server.

procedure Post; override;

Description

Post writes any changes to the current record to the database server. Dataset methods that change the dataset state, such as Edit, Insert, or Append, or that move from one record to another, such as First, Last, Next, and Prior automatically call Post.

Before posting the current record, Post checks the GeneratorField property to determine whether it must generate any field values before posting the record. After changing the generated field, if necessary, Post triggers a BeforePost event, writes the modified record to the server, and then triggers an AfterPost event.


TIBCustomDataSet.RecordModified

TIBCustomDataSet	See also

Sets the record to modified or unmodified.

procedure RecordModified(Value: Boolean);

Description

Call RecordModified to mark a record as modified or unmodified.

Note:  This method is for internal use.


TIBCustomDataSet.RevertRecord

TIBCustomDataSet	See also 	Example

Restores the current record in the dataset to an unmodified state when cached updates are enabled.

procedure RevertRecord;

Description

Call RevertRecord to undo changes made to the current record when cached updates are enabled.

Note:	To undo all changes to all pending updates in the cache, call CancelUpdates.


TIBCustomDataSet.SQLType

TIBCustomDataSet	See also

Returns the type of query to be executed.

type TIBSQLTypes = set of (SQLUnknown, SQLSelect, SQLInsert, SQLUpdate, SQLDelete, SQLDDL, SQLGetSegment, SQLPutSegment, SQLExecProcedure, SQLStartTransaction, SQLCommit, SQLRollback, SQLSelectForUpdate, SQLSetGenerator);

property SQLType: TIBSQLTypes read FSQLType;

Description

Use the SQLType to determine the type of query to be executed. This is the same as the SQLType property of the query specified by QSelect. Query types include:

SQLCommit	Commits an active transaction
SQLDDL	Modifies the database metadata
SQLDelete	Removes rows in a table or in the active set of a cursor
SQLExecProcedure	Calls a stored procedure
SQLGetSegment	Reads a segment from an open Blob
SQLInsert	Adds one or more new rows to a specified table
SQLPutSegment	Writes a Blob segment
SQLRollback	Restores the database to its state prior to the start of the current transaction
SQLSelectForUpdate	Used for positioned updates.
SQLSetGenerator	Sets a new value for an existing generator
SQLSelect	Retrieves data from one or more tables
SQLStartTransaction	Starts a new transaction against one or more databases
SQLUnknown	Unknown SQL type
SQLUpdate	Changes data in all or part of an existing row in a table, view, or active set of a cursor


TIBCustomDataSet.Undelete

TIBCustomDataSet	See also

Restores a record deleted from the dataset.

procedure Undelete;

Description

Call Undelete to restore a record deleted or uninserted from the dataset.


TIBCustomDataSet.UpdateStatus

TIBCustomDataSet	See also

Reports the update status for the current record.

type TUpdateStatus = (usUnmodified, usModified, usInserted, usDeleted);

function UpdateStatus: TUpdateStatus;

Description

Call UpdateStatus to determine the update status for the current record when cached updates are enabled. Update status can change frequently as records are edited, inserted, or deleted. UpdateStatus offers a convenient method for applications to assess the current status before undertaking or completing operations that depend on the update status of records.


Hierarchy

TObject

TPersistent

TComponent

TDataSet

TIBCustomDataSet


 TIBDatabase

Hierarchy	Properties	Methods	Events	See also

TIBDatabase encapsulates an InterBase database connection.

Unit

IBDataBase

Description

Use TIBDatabase to encapsulate an InterBase database connection.  All TIBCustomDataSet descendants and TIBSQL use the TIBDatabase component to gain access to databases.


TIBDatabase properties

TIBDatabase	Alphabetically	Legend

In TIBDatabase

AllowStreamedConnected

Connected

DatabaseName

DBParamByDPB

DBSQLDialect

DefaultTransaction

Handle

HandleIsShared

IdleTimer

InternalTransaction

IsReadOnly

Params

SQLDialect

SQLObjectCount

SQLObjects

TraceFlags

TransactionCount

Transactions

Derived from TCustomConnection

DataSetCount

DataSets

LoginPrompt

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBDatabase properties

TIBDatabase	By object	Legend

AllowStreamedConnected

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Connected

DatabaseName

DataSetCount

DataSets

DBParamByDPB

DBSQLDialect

DefaultTransaction

DesignInfo

Handle

HandleIsShared

IdleTimer

InternalTransaction

IsReadOnly

LoginPrompt

Name

Owner

Params

SQLDialect

SQLObjectCount

SQLObjects

Tag

TraceFlags

TransactionCount

Transactions

VCLComObject


TIBDatabase.AllowStreamedConnected

TIBDatabase	See also

Indicates whether the Connected property can be set at design time.

property AllowStreamedConnected : Boolean;

Description

When AllowStreamedConnected is True (the default), then setting the Connected property to True at design time causes this component to automatically establish a database connection when the application starts up. When AllowStreamedConnected is False, the connection must be explicitly opened at runtime, either by setting the Connected property to True, or by calling the Open method.

Set AllowStreamedConnected to False when using a local test database at design time and a different database at runtime. This allows the application to set the appropriate runtime connection information before opening a runtime connection, without having to explicitly shut down the database connection that is used at design time.


TIBDatabase.Connected

TIBDatabase	See also

Indicates whether or not a database connection is active.

property Connected : Boolean;

Description

Set Connected to True to establish a database connection without opening a dataset. Set Connected to False to close a database connection. An application can check Connected to determine the current status of a database connection. If Connected is True, the database connection is active; if False, then the connection is inactive.


TIBDatabase.DatabaseName

TIBDatabase	See also

Specifies the name of the database to associate with this database component.

property DatabaseName: String;

Description

Use DatabaseName to specify the name of the database to use with a database component. For local InterBase databases, this can be a filename.

To connect to an InterBase database on a remote server using TCP/IP the syntax is <server_name>:<filename>.

To connect to an InterBase database on a remote server using NetBEUI, the syntax is: \\<server_name>\<filename>.

To connect to an InterBase database on a remote server using SPX, the syntax is: <server_name>@<filename>.


TIBDatabase.DBParamByDPB

TIBDatabase	See also

Specifies the name of the database to associate with this database component.

property DBParamByDPB: [const Idx: Integer]: String;

Description

Use DBParamByDPB to inspect and set DPB parameters without looking at the Params string list.

For example,

DBParamByDPB[isc_dpb_user_name]

can be used to set and inspect the user name.


TIBDatabase.DBSQLDialect

TIBDatabase	See also

Returns the database SQL dialect.

property DBSQLDialect: Integer;

Description

Use DBSQLDialect to get the database SQL dialect.


TIBDatabase.DefaultTransaction

TIBDatabase	See also

Sets or returns the default database transaction.

property DefaultTransaction: TIBTransaction;

Description

Use DefaultTransaction to set or return the default database transaction.

A single database connection can manage one or more transactions.  DefaultTransaction is a convenient way to specify a default transaction to a database connection.


TIBDatabase.Handle

TIBDatabase	See also

Specifies the InterBase API database handle.

property Handle: TISC_DB_Handle;

Description

Use Handle to make calls directly to the InterBase API.  Many of the InterBase API functions require a database handle as one of their arguments.  Handle is assigned an initial value when a database is opened.


TIBDatabase.HandleIsShared

TIBDatabase	See also

Indicates whether or not a the handle is shared.

property HandleIsShared: Boolean;

Description

Read HandleIsShared to determine if the handle to the database is shared.


TIBDatabase.IdleTimer

TIBDatabase	See also

Specifies how long the database should wait before disconnecting an idle connection.

property IdleTimer: Integer;

Description

Use IdleTimer to indicate how long the database should wait before automatically terminating the connection.


TIBDatabase.InternalTransaction

TIBDatabase

Used internally by InterBase transactions.

property InternalTransaction: TIBTransaction;

Description

Do not use InternalTransaction directly.  It is for internal use only.


TIBDatabase.IsReadOnly

TIBDatabase	See also

Indicates whether or not the database is set to read-only.

property IsReadOnly: Boolean;

Description

Read IsReadOnly to determine if the database is read-only.

Note:  Read-only databases are an InterBase 6 feature.


TIBDatabase.Params

TIBDatabase	See also

Specifies the database parameters to pass to the InterBase server.

property Params: TStrings;

Description

Use Params to specify the database parameters to pass to the InterBase server.

Database parameters are passed to the server as text in order to establish the connection.  For example:

user_name=sysdba

password=masterkey

sql_role_name=finance

lc_ctype=WIN1252

For more information on character sets, refer to “Character Sets and Collation Orders” in the InterBase Language Reference.

For other information, refer to the InterBase API Guide.


TIBDatabase.SQLDialect

TIBDatabase	See also

Sets or returns the SQL dialect used by the client.

property SQLDialect: Integer;

Description

Use the SQLDialect property to set or return the SQL dialect used by the client.  If the connection is active, the SQLDialect property cannot be set to a value greater than the database SQL dialect.  If the connection is inactive, then on connect an OnDialectDowngradeWarning event may be fired if the SQLDialect is greater than the database SQL dialect.  In such a case, the SQLDialect property will be downgraded to match the database SQL dialect.


TIBDatabase.SQLObjectCount

TIBDatabase	See also

Returns the number of SQL objects.

property SQLObjectCount: Integer;

Description

Use the SQLObjectCount property to return the number of SQL objects in the database.

SQL objects are usually defined as InterBase datasets, IBSQL, and Blobs.


TIBDatabase.SQLObjects

TIBDatabase	See also

Returns an SQL object.

property SQLObjects[Index: Integer]: TIBBase;

Description

Use the SQLObjects property to return an SQL object based on its numeric index.

SQL objects are usually defined as InterBase datasets, IBSQL, and Blobs.


TIBDatabase.TraceFlags

TIBDatabase	See also

Specifies the database operations to track with the SQL Monitor at runtime.

type

TTraceFlag = (tfQPrepare, tfQExecute, tfQFetch, tfError, tfStmt, tfConnect, tfTransact, tfBlob, tfService, tfMisc);

TTraceFlags = set of TTraceFlag;

property TraceFlags: TTraceFlags;

Description

Use TraceFlags to specify which database operations the SQL Monitor should track in an application at runtime. TraceFlags is only meaningful for the SQL Monitor, which is provided to enable performance tuning and SQL debugging when working with remote SQL database servers.

Note:	Normally trace options are set from the SQL Monitor rather than setting TraceFlags in application code.

The value of a session component’s TraceFlags property determines the initial settings of the TraceFlags property for database components associated with the session.

The TTraceFlags type defines the individual values that can be included in the TraceFlags property. The following table summarizes those values:

tfQPrepare	Monitor Prepare statements.
tfQExecute	Monitor ExecSQL statements.
tfQFetch	Monitor Fetch statements.
tfError	Monitor server error messages. Such messages may include an error code.
tfStmt	Monitor all SQL statements.
tfConnect	Monitor database connect and disconnect operations, including allocation of connection handles, and freeing connection handles.
tfTransact	Monitor transaction statements, such as StartTransaction, Commit, and Rollback.
tfBlob	Monitor operations on blob data types.
tfService	Monitor services.
tfMisc	Monitor any statements not covered by other flag options.
Because TraceFlags is a set property, an application can specify different combinations of flags to monitor different combinations of statements. For example, the following statement limits monitoring to database connections and SQL statement preparation:

TraceFlags := [tfConnect, tfQPrepare];


TIBDatabase.TransactionCount

TIBDatabase	See also

Returns the number of transactions associated with the TIBDatabase component.

property TransactionCount: Integer;

Description

Use TransactionCount to return how many transactions are currently associated with the InterBase database component.


TIBDatabase.Transactions

TIBDatabase	See also

Specifies a transaction for the given index.

property Transactions [Index: Integer]: TIBTransaction;

Description

Given an integer index, Transactions returns the transaction at the given index.  This is used internally for broadcasting important messages to attached components.


TIBDatabase events

TIBDatabase	Alphabetically	Legend

In TIBDatabase

OnDialectDowngradeWarning

OnIdleTimer

OnLogin

Derived from TCustomConnection

AfterConnect

AfterDisconnect

BeforeConnect

BeforeDisconnect


TIBDatabase events

TIBDatabase	By object	Legend

AfterConnect

AfterDisconnect

BeforeConnect

BeforeDisconnect

OnDialectDowngradeWarning

OnIdleTimer

OnLogin


TIBDatabase.OnDialectDowngradeWarning

TIBDatabase	See also

Occurs after the SQL dialect of the client connection is downgraded.

property OnDialectDowngradeWarning: TNotifyEvent;

Description

Write an OnDialectDowngradeWarning event handler to take specific actions when the SQL dialect is downgraded.

For example, if the SQL dialect for your application is set to 3 and then a connection is made to a dialect 1 database, then the SQL dialect is downgraded to 1 and a OnDialectDowngradeWarning event is fired.


TIBDatabase.OnIdleTimer

TIBDatabase	See also

Occurs after a database connection times out.

property OnIdleTimer: TNotifyEvent;

Description

Write an OnIdleTimer event handler to take specific actions when the connection times out in the time specified by IdleTimer.


TIBDatabase.OnLogin

TIBDatabase	See also

Occurs when an application connects to a database.

TIBDatabaseLoginEvent = procedure(Database: TIBDatabase; LoginParams: TStrings) of object;

property OnLogin: TIBDatabaseLoginEvent;

Description

Write an OnLogin event handler to take specific actions when an application attempts to connect to a database. By default, a database login is required. The current USER_NAME is read from the Params property, and a standard Login dialog box opens. The dialog prompts for a user name and password combination, and then uses the values entered by the user to set the USER_NAME and PASSWORD values in the Params property. These values are then passed to the remote server.

Applications that provide alternative OnLogin event handlers must set the USER_NAME and PASSWORD values in LoginParams. LoginParams is a temporary string list and is freed automatically when no longer needed.

Note:	OnLogin does not occur unless the LoginPrompt property is set to True.


TIBDatabase methods

TIBDatabase	Alphabetically	Legend

In TIBDatabase

AddEventNotifier

AddTransaction

ApplyUpdates

Call

CheckActive

CheckDatabaseName

CheckInactive

CloseDataSets

Create

CreateDatabase

Destroy

DropDatabase

FindDefaultTransaction

FindTransaction

FlushSchema

ForceClose

GetFieldNames

GetTableNames

Has_COMPUTED_BLR

Has_DEFAULT_VALUE

IndexOfDBConst

RemoveEventNotifier

RemoveTransaction

RemoveTransactions

SetHandle

TestConnected

Derived from TCustomConnection

Close

Open

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBDatabase methods

TIBDatabase	By object	Legend

AddEventNotifier

AddTransaction

AfterConstruction

ApplyUpdates

Assign

BeforeDestruction

Call

CheckActive

CheckDatabaseName

CheckInactive

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

CloseDataSets

Create

CreateDatabase

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

DropDatabase

ExecuteAction

FieldAddress

FindComponent

FindDefaultTransaction

FindTransaction

FlushSchema

ForceClose

Free

FreeInstance

FreeNotification

FreeOnRelease

GetFieldNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetTableNames

Has_COMPUTED_BLR

Has_DEFAULT_VALUE

HasParent

IndexOfDBConst

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

Open

ReferenceInterface

RemoveComponent

RemoveEventNotifier

RemoveFreeNotification

RemoveTransaction

RemoveTransactions

SafeCallException

SetHandle

SetSubComponent

TestConnected

UpdateAction


TIBDatabase.AddEventNotifier

TIBDatabase	See also

Adds an event notifier to the database’s internal list so that the database can handle registering and unregistering interest in events.

procedure AddEventNotifier(Notifier: IIBEventNotifier);

Description

Call AddEventNotifier when you want the database to automatically register and unregister an interest in server events when it opens and closes a connection to the server.

Notifier is the interface to an object that has in interest in a set of events on the InterBase server. For example, Notifier can be the interface to a TIBEvents object.

AddEventNotifier adds Notifier to its internal list of event notifiers. When TIBDatabase opens a connection, it checks every notifier in its list, and if a notifier indicates that it wants to be auto-registered, AddEventNotifier calls its RegisterEvents method so that the notifier registers its interest with the InterBase Event manager. Before TIBDatabase closes a connection, it unregisters interest from every notifier in its list.

Note:	If Notifier is a TIBEvents object, AddEventNotifier is automatically called when you set the Database property.


TIBDatabase.AddTransaction

TIBDatabase	See also

Adds an association between the transaction component and the database component.

function AddTransaction(TR: TIBTransaction): Integer;

Description

Call AddTransaction to add an association between the transaction component and the database component.


TIBDatabase.ApplyUpdates

TIBDatabase	See also

Posts pending cached updates for specified datasets to the database server.

procedure ApplyUpdates(const DataSets: array of TDataSet);

Description

Call ApplyUpdates to post pending cached updates for a specific set of open datasets to the database server. ApplyUpdates is only meaningful if the CachedUpdates property of a specified dataset is True.

DataSets is a list of dataset names specifying the datasets for which to post pending updates. DataSets need not list every currently open dataset. For each listed dataset ApplyUpdates calls the dataset’s ApplyUpdates and CommitUpdates methods to post that dataset’s pending cached updates.


TIBDatabase.Call

TIBDatabase	See also

Returns an error message based on the error code.

function Call (ErrCode: ISC_STATUS; RaiseError: Boolean): ISC_STATUS;

Description

Call is an internal method used to make calls to the InterBase API, and gives you the option of raising an exception or returning an error based on the value of RaiseError.


TIBDatabase.CheckActive

TIBDatabase	See also

Checks to see if the database connection is active.

procedure CheckActive;

Description

Call CheckActive to return an error if the connection to a database server is inactive.


TIBDatabase.CheckDatabaseName

TIBDatabase	See also

Checks to see if the DatabaseName property is not empty.

procedure CheckDatabaseName;

Description

Call CheckDatabaseName to check if the DatabaseName property is empty, and to return an error if it is.


TIBDatabase.CheckInactive

TIBDatabase	See also

Checks to see if the database connection is inactive.

procedure CheckInactive;

Description

Call CheckInactive to return an error if the connection to a database server is active.


TIBDatabase.CloseDataSets

TIBDatabase	See also

Closes all datasets associated with the database component without disconnecting from the database server.

procedure CloseDataSets;

Description

Call CloseDataSets to close all active datasets without disconnecting from the database server. Ordinarily, when an application calls Close, all datasets are closed, and the connection to the database server is dropped. Calling CloseDataSets instead of Close ensures that an application can close all active datasets without having to reconnect to the database server at a later time.


TIBDatabase.Create

TIBDatabase	See also

Creates an instance of a TIBDatabase component.

constructor Create(AOwner: TComponent);

Description

Call Create to instantiate a database component at runtime. An application can create a database component in order to control the component’s existence and set its properties and events.

Create instantiates a database component and creates an empty list of dataset components for the DataSets property and an empty string list for the Params property.


TIBDatabase.CreateDatabase

TIBDatabase	See also

Creates a database using Params.

procedure CreateDatabase;

Description

Call CreateDatabase to create a database using Params as the rest of the CREATE DATABASE command.

For example, if you wanted to create a local InterBase database, you could do the following:

1. Set the database name to the drive, path, and filename of the database file.

2. Set Params to the parameter for the CREATE DATABASE statement:

USER "SYSDBA"

PASSWORD "masterkey"

PAGE_SIZE 4096

3. Set the SQLDialect value.

4. Call the CreateDatabase method.


TIBDatabase.Destroy

TIBDatabase	See also

Destroys the instance of the database component.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free, which verifies that the database component is not already freed before calling Destroy.

Destroy disconnects from the database server, if necessary. It then frees the string resources allocated for the Params and DataSets properties before calling its inherited destructor.


TIBDatabase.DropDatabase

TIBDatabase	See also

Drops a database.

procedure DropDatabase;

Description

Call DropDatabase to drop a database, which removes the database file from the server.


TIBDatabase.FindDefaultTransaction

TIBDatabase	See also

Returns the default transaction.

function FindDefaultTransaction(): TIBTransaction;

Description

Call FindDefaultTransaction to return the default transaction for the database.


TIBDatabase.FindTransaction

TIBDatabase	See also

Finds the index of a transaction.

function FindTransaction (TR: TIBTransaction): Integer;

Description

Call FindTransaction to find the index of a specified transaction.


TIBDatabase.FlushSchema

TIBDatabase

Clears the schema cache for the database.

procedure FlushSchema;

Description

Call FlushSchema to clear the schema cache.


TIBDatabase.ForceClose

TIBDatabase

Forces the database connection to close.

procedure ForceClose;

Description

Use ForceClose to force the database connection to close.

Note:	Forcing a database to close attempts to close the connection to the server.  Even if the  call fails, the database handle is reset to nil.


TIBDatabase.GetFieldNames

TIBDatabase	See also

Populates a list with the names of the fields in the table.

procedure GetFieldNames(const TableName: string; List: TStrings);

Description

Call GetFieldNames to retrieve a list of fields in the associated table.


TIBDatabase.GetTableNames

TIBDatabase	See also

Populates a string list with the names of tables in the database.

procedure GetTableNames(List: TStrings; SystemTables: Boolean = False);

Description

Call GetTableNames to retrieve a list of tables in the associated database.

List is the already-existing string list object into which the tables’ names are put.

Set SystemTables to indicate whether the list of table names should include the database’s system tables.

IBDatabase1.GetTableNames(ListBox2.Items, False);

Note:	Any contents already in the target string list object are eliminated and overwritten by the data produced by GetTableNames.


TIBDatabase.Has_COMPUTED_BLR

TIBDatabase	See also

Indicates whether a specified field in a specified relation includes a COMPUTED_BLR attribute.

function Has_COMPUTED_BLR(Relation, Field : String) : Boolean;

Description

Call Has_COMPUTED_BLR to determine whether Field and Relation includes a COMPUTED_BLR attribute.


TIBDatabase.Has_DEFAULT_VALUE

TIBDatabase	See also

Indicates whether a specified field in a specified relation includes a DEFAULT_VALUE attribute.

function Has_DEFAULT_VALUE(Relation, Field : String) : Boolean;

Description

Call Has_DEFAULT_VALUE to determine whether Field has a default value when used in Relation.


TIBDatabase.IndexOfDBConst

TIBDatabase	See also

Searches for the named parameter in the database parameters list.

function IndexOfDBConst(st: String): Integer;

Description

Use IndexOfDBConst to locate a parameter in the database parameters list.  IndexOfDBConst returns –1 if the parameter is not found.


TIBDatabase.RemoveEventNotifier

TIBDatabase	See also

Removes an event notifier from the database’s internal list so that the database no longer handles registering and unregistering interest in events.

procedure RemoveEventNotifier(Notifier: IIBEventNotifier);

Description

Call RemoveEventNotifier when you no longer want the database to automatically register and unregister an interest in server events when it opens and closes a connection to the server. For example, TIBEvents automatically calls RemoveEventNotifier when you change its Database property.

Notifier is the event notifier previously added to the database’s internal list by a call to AddEventNotifier.

RemoveEventNotifier removes Notifier from its internal list of event notifiers.

Note:	Removing an event notifier from the list does not first unregister an interest in any registered events.


TIBDatabase.RemoveTransaction

TIBDatabase	See also

Disassociates a transaction from the database.

procedure RemoveTransaction(Idx: Integer);

Description

Call RemoveTransaction to disassociate a specified transaction from the database.


TIBDatabase.RemoveTransactions

TIBDatabase	See also

Disassociates all transactions from the database.

procedure RemoveTransactions;

Description

Call RemoveTransactions to disassociate all transactions from the database.


TIBDatabase.SetHandle

TIBDatabase	See also

Sets the handle for the database.

procedure SetHandle;

Description

Call SetHandle to set the handle for the database.


TIBDatabase.TestConnected

TIBDatabase	See also

Tests whether a database is connected.

procedure TestConnected: Boolean;

Description

Use TestConnected to determine whether a database is connected to the server.  TestConnected returns True if the connection is good, and False if it is not.


Hierarchy

TObject

TPersistent

TComponent

TCustomConnection

TIBDatabase


IBDatabase Editor dialog box

The Database Editor dialog box sets up the properties of a database that specify the connection that should be made to a database. This dialog box allows you to specify the type of database, the connection parameters, the user name, SQL role, and password, and whether or not a login prompt is required.

These properties of the database component, as well as others, can also be specified using the Object Inspector.

To display the Database Editor dialog box, double click on an IBDatabase component.

Dialog box options

Connection

Option	Meaning
Local	Indicates that the database is on the local server. Enables the Browse button, allowing you to search for the database with a Open File dialog.
Remote	Indicates that the database is on a remote server. Activates the Protocol and Server fields
Protocol	Sets the protocol for attaching to the remote server. The protocol can be TCP/IP, Named Pipe, or SPX.
Server	The name of the remote server.
Database	The name of the database.
Database Parameters

Option	Meaning
User Name	The name of the database user.
Password	The password for the database user.
SQLRole	The SQLRole name used to connect to the database.
Character Set	The character set used to connect to the database.
Login Prompt	Indicates whether a login prompt is required to access the database.
Settings	Displays the current parameters and allows you to add other parameters.  For example: user_name=sysdba password=masterkey sql_role_name=finance lc_ctype=WIN1252  For more information on database parameters, see the InterBase API Guide.


 TIBDatabaseInfo

Hierarchy	Properties 	Methods

TIBDatabaseInfo returns information about the attached database.

Unit

IBDatabaseInfo

Description

Use TIBDatabaseInfo to fetch information about the attached database, such as the version of the online disk structure (ODS) used by the attachment, the number of database cache buffers allocated, the number of database pages read from or written to, or write-ahead log information.


TIBDatabaseInfo properties

TIBDatabaseInfo	Alphabetically	Legend

In TIBDatabaseInfo

Allocation

BackoutCount

BaseLevel

CurrentMemory

Database

DBFileName

DBImplementationClass

DBImplementationNo

DBSiteName

DBSQLDialect

DeleteCount

ExpungeCount

Fetches

ForcedWrites

InsertCount

Marks

MaxMemory

NoReserve

NumBuffers

ODSMajorVersion

ODSMinorVersion

PageSize

PurgeCount

ReadIdxCount

ReadOnly

Reads

ReadSeqCount

SweepInterval

UpdateCount

UserNames

Version

Writes

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBDatabaseInfo properties

TIBDatabaseInfo	By object	Legend

Allocation

BackoutCount

BaseLevel

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

CurrentMemory

Database

DBFileName

DBImplementationClass

DBImplementationNo

DBSiteName

DBSQLDialect

DeleteCount

DesignInfo

ExpungeCount

Fetches

ForcedWrites

InsertCount

Marks

MaxMemory

Name

NoReserve

NumBuffers

ODSMajorVersion

ODSMinorVersion

Owner

PageSize

PurgeCount

ReadIdxCount

ReadOnly

Reads

ReadSeqCount

SweepInterval

Tag

UpdateCount

UserNames

VCLComObject

Version

Writes


TIBDatabaseInfo.Allocation

TIBDatabaseInfo	See also 	Example

Returns the number of database pages allocated.

property Allocation: Long;

Description

Use Allocation to return the number of database pages allocated.


TIBDatabaseInfo.BackoutCount

TIBDatabaseInfo	See also 	Example

Returns the number of removals of a version of a record.

property BackoutCount: TStringList;

Description

Use BackoutCount to determine the number of times a version of a database record has been removed.


TIBDatabaseInfo.BaseLevel

TIBDatabaseInfo	See also 	Example

Returns the database version number.

property BaseLevel: Long;

Description

Use BaseLevel to return the database version number, which consists of 1 byte containing the number 1, and 1 byte containing the version number.


TIBDatabaseInfo.CurrentMemory

TIBDatabaseInfo	See also 	Example

Returns the amount of server memory currently in use.

property CurrentMemory: Long;

Description

Use CurrentMemory to return the amount of server memory (in bytes) currently in use.


TIBDatabaseInfo.Database

TIBDatabaseInfo	See also 	Example

Sets or returns the database.

property Database: TIBDatabase;

Description

Use Database to set or return the database on which information is being returned.


TIBDatabaseInfo.DBFileName

TIBDatabaseInfo	See also 	Example

Returns the database filename.

property DBFileName: String;

Description

Use DBFileName to return the database filename.


TIBDatabaseInfo.DBImplementationClass

TIBDatabaseInfo	See also 	Example

Returns the database implementation class number.

property DBImplementationClass: Long;

Description

Use DBImplementationClass to return the database implementation class number, either 1 or 12.


TIBDatabaseInfo.DBImplementationNo

TIBDatabaseInfo	See also 	Example

Returns the database implementation number.

property DBImplementationNo: Long;

Description

Use DBImplementationNo to return the database implementation number.


TIBDatabaseInfo.DBSiteName

TIBDatabaseInfo	See also 	Example

Returns the database site name.

property DBSiteName: String;

Description

Use DBSiteName to return the database site name.


TIBDatabaseInfo.DBSQLDialect

TIBDatabaseInfo	Example

Returns the SQL dialect.

property DBSQLDialect: Long;

Description

Use DBSQLDialect to return the SQL dialect.


TIBDatabaseInfo.DeleteCount

TIBDatabaseInfo	See also 	Example

Returns the number of database deletes since the database was last attached.

property DeleteCount: TStringList;

Description

Use DeleteCount to return the number of database deletes since the database was last attached.


TIBDatabaseInfo.ExpungeCount

TIBDatabaseInfo	See also 	Example

Returns the number of removals of a record and all of its ancestors.

property ExpungeCount: TStringList;

Description

Use ExpungeCount to return the number of removals of a record and all of its ancestors for records whose deletions have been committed.


TIBDatabaseInfo.Fetches

TIBDatabaseInfo	See also 	Example

Returns the number of reads from the memory buffer cache.

property Fetches: Long;

Description

Use Fetches to return the number of reads from the memory buffer cache.


TIBDatabaseInfo.ForcedWrites

TIBDatabaseInfo	See also 	Example

Returns the mode in which database writes are performed.

property ForcedWrites: Long;

Description

Use ForcedWrites to return the number specifying the mode in which database writes are performed.  ForcedWrites returns 0 for asynchronous mode, or returns 1 for synchronous mode


TIBDatabaseInfo.InsertCount

TIBDatabaseInfo	See also 	Example

Returns number of inserts into the database since the database was last attached.

property InsertCount: TStringList;

Description

Use InsertCount to return the number of inserts into the database since the database was last attached.


TIBDatabaseInfo.Marks

TIBDatabaseInfo	See also 	Example

Returns the number of writes to the memory buffer cache.

property Marks: Long;

Description

Use Marks to return the number of writes to the memory buffer cache.


TIBDatabaseInfo.MaxMemory

TIBDatabaseInfo	See also 	Example

Returns the maximum amount of memory used at one time since the first process attached to the database.

property MaxMemory: Long;

Description

Use MaxMemory to return in bytes the maximum amount of memory used at one time since the first process attached to the database.


TIBDatabaseInfo.NoReserve

TIBDatabaseInfo	See also 	Example

Returns whether or not space is reserved on each database page for holding backup versions of modified records.

property NoReserve: Long;

Description

Use NoReserve to return whether or not space is reserved on each database page for holding backup versions of modified records.  NoReserve will return 0 to indicate that space is reserved (the default) or 1 to indicate that no space is reserved.


TIBDatabaseInfo.NumBuffers

TIBDatabaseInfo	See also 	Example

Returns the number of memory buffers currently allocated.

property NumBuffers: Long;

Description

Use NumBuffers to return the number of memory buffers currently allocated.


TIBDatabaseInfo.ODSMajorVersion

TIBDatabaseInfo	See also 	Example

Returns the on disk structure (ODS) major version number.

property ODSMajorVersion: Long;

Description

Use ODSMajorVersion to return the ODS major version number for the database.  Databases with different major version numbers have different physical layouts.

A database engine can access only databases with a particular ODS major version number;  trying to attach to a database with a different ODS number results in an error.


TIBDatabaseInfo.ODSMinorVersion

TIBDatabaseInfo	See also 	Example

Returns the on disk structure (ODS) minor version number.

property ODSMinorVersion: Long;

Description

Use ODSMinorVersion to return the (ODS) minor version number.  An increase in a minor version number indicates a non-structural change, one that still allows the database to be accessed by databases with the same major version number but possibly different minor version numbers.


TIBDatabaseInfo.PageSize

TIBDatabaseInfo	See also 	Example

Returns the number of bytes per page of the attached database.

property PageSize: Long;

Description

Use PageSize to return the number of bytes per page of the attached database.  Use with Allocation to determine the size of the database.


TIBDatabaseInfo.PurgeCount

TIBDatabaseInfo	See also 	Example

Returns the number of removals of fully mature records from the database.

property PurgeCount: TStringList;

Description

Use PurgeCount to return the number of removals of fully mature records (that is, records committed, resulting in older versions no longer being needed) from the database.


TIBDatabaseInfo.ReadIdxCount

TIBDatabaseInfo	See also 	Example

Returns the number of reads done via an index since the database was last attached.

property ReadIdxCount: TStringList;

Description

Use ReadIdxCount to return the number of reads done via an index since the database was last attached.


TIBDatabaseInfo.ReadOnly

TIBDatabaseInfo	See also 	Example

Indicates whether or not the database is read only.

property ReadOnly: Long;

Description

Use ReadOnly to determine whether the database is read only or not.  ReadOnly returns 1 if the database is read-write and 0 if it is read only.

Note:  Read-only databases are an InterBase 6 feature.


TIBDatabaseInfo.Reads

TIBDatabaseInfo	See also 	Example

Returns the number of page reads from the database.

property Reads: Long;

Description

Use Reads to return the number of page reads from the database since the current database was first attached, that is, an aggregate of all reads done by all attached processes, rather than the number of reads done for the calling program since it attached to the database.


TIBDatabaseInfo.ReadSeqCount

TIBDatabaseInfo	See also 	Example

Returns the number of sequential database reads done on each table since the database was last attached.

property ReadSeqCount: TStringList;

Description

Use ReadSeqCount to return the number of sequential database reads (that is, the number of sequential table scans) done on each table since the database was last attached


TIBDatabaseInfo.SweepInterval

TIBDatabaseInfo	See also 	Example

Returns the number of transactions that are committed between “sweeps.”

property SweepInterval: Long;

Description

Use SweepInterval to return the number of transactions that are committed between “sweeps” to remove database record versions that are no longer needed.


TIBDatabaseInfo.UpdateCount

TIBDatabaseInfo	See also 	Example

Returns the number of database updates since the database was last attached.

property UpdateCount: TStringList;

Description

Use UpdateCount to return the number of database updates since the database was last attached.


TIBDatabaseInfo.UserNames

TIBDatabaseInfo	See also 	Example

Returns the names of all users currently attached to the database.

property UserNames: TStringList;

Description

Use UserNames to return the names of all users currently attached to the database.


TIBDatabaseInfo.Version

TIBDatabaseInfo	See also 	Example

Returns the version of the database implementation.

property Version: String;

Description

Use Version to return the version identification string of the database implementation.


TIBDatabaseInfo.Writes

TIBDatabaseInfo	See also	Example

Returns the number of page writes to the database.

property Writes: Long;

Description

Use Writes to return the number of page writes to the current database since it was first attached by any process; that is, an aggregate of all write done by all attached processes, rather than the number of writes done for the calling program since it attached to the database.


TIBDatabaseInfo methods

TIBDatabaseInfo	Alphabetically	Legend

In TIBDatabaseInfo

Call

Create

Destroy

GetLongDatabaseInfo

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBDatabaseInfo methods

TIBDatabaseInfo	By object	Legend

AfterConstruction

Assign

BeforeDestruction

Call

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetLongDatabaseInfo

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction


TIBDatabaseInfo.Call

TIBDatabaseInfo

Returns an error message based on the error code.

function Call(ErrCode: ISC_STATUS; RaiseError: Boolean): ISC_STATUS;

Description

Call is an internal method used to make calls to the InterBase API, and gives you the option of raising an exception or returning an error based on the value of RaiseError.


TIBDatabaseInfo.GetLongDatabaseInfo

TIBDatabaseInfo

Returns a specified long integer that describes some aspect of the associated database.

function GetLongDatabaseInfo(DatabaseInfoCommand: Integer): Long;

Description

TIBDatabaseInfo uses GetLongDatabaseInfo internally to fetch information that can be expressed as a long integer. For example, this method provides the underlying implementation for fetching the version number or page size. It is exposed as a public member so that as the underlying _DatabaseInfoCommand interface expands its capabilities, TIBDatabaseInfo can still be used to fetch information for which there is no specified property.

DatabaseInfoCommand is an index that identifies the information to fetch. It is one of the constants declared in the IBHeader unit.

Long returns desired information.


TIBDatabaseInfo.Create

TIBDatabaseInfo	See also

Creates an instance of a DatabaseInfo component.

constructor Create (AOwner: TComponent);

Description

Call Create to instantiate a DatabaseInfo component declared in an application.


TIBDatabaseInfo.Destroy

TIBDatabaseInfo	See also

Destroys an instance of a DatabaseInfo component.

Destructor Destroy;

Description

Do not call Destroy directly. Instead call Free to verify that the DatabaseInfo component is not already freed before calling Destroy. Destroy disconnects from the server, frees the parameter list, and calls its inherited Destroy destructor.


Hierarchy

TObject

TPersistent

TComponent

TIBDatabaseInfo


 TIBDataLink

Hierarchy 	Properties	Methods	See also

TIBDataLink is a helper class used by data-aware objects to coordinate the actions of TIBDataSet and to respond to data events.

Unit

IBCustomDataSet

Description

Use TIBDataLink or one of its descendants in any data-aware object that implements a DataSource property to represent its link to a dataset or that needs to respond to data events.

The constructor of the data-aware object should call the constructor of TIBDataLink, and initialize any relevant properties. The data-aware object can then link to a TDataSource by using the DataSource property of the TIBDataLink.

Data-aware objects that link to a single field in a dataset should use a TFieldDataLink instead.


TIBDataLink properties

TIBDataLink	Alphabetically	Legend

In TIBDataLink

DetailDataSet

Derived from TDataLink

Active

ActiveRecord

BOF

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

ReadOnly

RecordCount


TIBDataLink properties

TIBDataLink	By object	Legend

Active

ActiveRecord

BOF

BufferCount

DataSet

DataSource

DataSourceFixed

DetailDataSet

Editing

Eof

ReadOnly

RecordCount


TIBDataLink.DetailDataSet

TIBDataLink 	See also

Indicates the detail dataset in the master/detail relationship.

property DetailDataSet: TDataSet;

Description

Read DetailDataSet to access the detail dataset. This is the dataset that uses a DetailDataLink to access its master dataset. The detail dataset is the detail datalink’s owner, and uses the datalink to implement its DataSource property.

Note:	Do not confuse the DetailDataSet property with the DataSet property. The DataSet property is the dataset whose data events the detail datalink tracks. That is, DataSet is the master dataset while DetailDataSet is the detail set.


TIBDataLink methods

TIBDataLink	Alphabetically	Legend

In TIBDataLink

Create

Destroy

Derived from TDataLink

Edit

ExecuteAction

UpdateAction

UpdateRecord

Derived from TPersistent

Assign

GetNamePath

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBDataLink methods

TIBDataLink	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

Edit

ExecuteAction

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

UpdateAction

UpdateRecord


TIBDataLink.Create

TIBDataLink	See also

Creates an instance of TIBDataLink.

constructor Create(ADataSet: TIBCustomDataSet);

Description

Create is called from the constructor of any data-aware object that uses a TIBDataLink to implement its DataSource property.

After calling the inherited constructor, Create initializes the BufferCount property to 1. Data-aware objects that use a TIBDataLink object to manage their link to a DataSource should change the BufferCount property to the number or records they represent, after calling the inherited constructor.


TIBDataLink.Destroy

TIBDataLink	See also

Destroys an instance of TIBDataLink.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call the Free method. Free verifies that the TIBDataLink object is not already freed and only then calls Destroy.

Before calling the inherited destructor, Destroy removes any reference to the TIBDataLink from the data source object.

The TIBDataLink object should be destroyed in the destructor of its Owner, where that Owner calls Create from its constructor.


Hierarchy

TObject

TPersistent

TDataLink

TDetailDataLink

TIBDataLink


TIBDSBlobStream

Hierarchy	Properties	Methods	See also

TIBDSBlobStream reads from and writes to BLOB fields on behalf of an IB Dataset.

Unit

IBCustomDataSet

Description

TIBDSBlobStream is the type of stream returned when an application calls an IB dataset’s CreateBlobStream method. Use this stream to access or modify the value of a Blob field in the dataset. TIBDSBlobStream allows objects that have no specialized knowledge of how data is stored in a Blob field to read or write such data by employing the uniform stream interface.

To use TIBDSBlobStream, call CreateBlobStream to obtain an instance of the stream and use the methods of the stream to read or write the data. The dataset retains ownership of the stream, so you should not free this Blob stream when you are done.


TIBDSBlobStream properties

TIBDSBlobStream	Alphabetically	Legend

Derived from TStream

Position

Size


TIBDSBlobStream properties

TIBDSBlobStream	By object	Legend

Position

Size


TIBDSBlobStream methods

TIBDSBlobStream	Alphabetically	Legend

In TIBDSBlobStream

Create

Read

Seek

SetSize

Write

Derived from TStream

CopyFrom

FixupResourceHeader

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

WriteResourceHeader

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBDSBlobStream methods

TIBDSBlobStream	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

CopyFrom

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

FixupResourceHeader

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

Read

ReadBuffer

ReadComponent

ReadComponentRes

ReadResHeader

SafeCallException

Seek

SetSize

Write

WriteBuffer

WriteComponent

WriteComponentRes

WriteDescendent

WriteDescendentRes

WriteResourceHeader


TIBDSBlobStream.Create

TIBDSBlobStream	See also

Resets the stream to the beginning of the Blob.

type TBlobStreamMode = (bmRead, bmWrite, bmReadWrite);

constructor Create(AField: TField ABlobStream: TIBBlobStream; Mode: TBlobStreamMode);

Description

Call Create to reset the stream to the beginning of the Blob.  Depending on the mode, it also truncates the Blob stream.


TIBDSBlobStream.Destroy

TIBDSBlobStream	See also

Frees the instance of TIBDSBlobStream.

destructor Destroy; override;

Description

Destroy frees the blob stream object and writes the BLOB value to the underlying TBlobField object.

Do not explicitly destroy the instance of TIBDSBlobStream that you obtain by calling a dataset’s CreateBlobStream method. The Dataset retains ownership of this stream and is responsible for freeing it.

When working with a Blob stream that you explicitly create and destroy, use the TIBBlobStream class instead.


TIBDSBlobStream.Read

TIBDSBlobStream	See also

Reads the requested number of bytes from the Blob.

function Read(var Buffer; Count: Longint): Longint;

Description

Call Read to read data from the Blob field when the number of bytes in the field’s data is not known. Buffer must have at least Count bytes allocated to hold the data that was read from the field.

Read transfers up to Count bytes from the Blob data into Buffer, starting in the current position, and then advances the current position by the number of bytes actually transferred. Read returns the number of bytes actually transferred (which may be less than the number requested in Count.)

Read checks the Transliterate property of the field, and converts the data into ANSI from the character set specified by the dataset if Transliterate is True.

All the other data-reading methods of a Blob stream (ReadBuffer, ReadComponent) call Read to do their actual reading.

Note:	Do not call Read when the TIBDSBlobStream was created in bmWrite mode.


TIBDSBlobStream.Seek

TIBDSBlobStream	See also

Resets the current position of the TIBDSBlobStream object.

function Seek(Offset: Longint; Origin: Word): Longint;

Description

Use Seek to move the current position within the Blob data by the indicated offset. Seek allows an application to read from or write to a particular location within the Blob data.

The Origin parameter indicates how to interpret the Offset parameter. Origin should be one of the following values:

Value	Meaning
soFromBeginning	Offset is from the beginning of the Blob data Seek moves to the position Offset Offset must be >= 0
soFromCurrent	Offset is from the current position in the Blob data Seek moves to Position + Offset
soFromEnd	Offset is from the end of the Blob data Offset must be <= 0 to indicate a number of bytes before the end of the Blob
Seek returns the new value of the Position property, the new current position in the Blob data.


TIBDSBlobStream.SetSize

TIBDSBlobStream	See also

Set the size of the Blob to the requested size.

procedure SetSize(NewSize: Long);

Description

Call SetSize to set the size of the Blob to the requested size.


TIBDSBlobStream.Write

TIBDSBlobStream	See also

Sets the field to be modified.

function Write(const Buffer; Count: Longint): Longint;

Description

Use Write to set the field to be modified, write the requested number of bytes to the Blob stream.


Hierarchy

TObject

TStream

TIBDSBlobStream


 TIBDataSet

Hierarchy	Properties	Methods	Events	See also

TIBDataSet executes InterBase SQL statements.

Unit

IBCustomDataSet

Description

Use TIBDataSet to execute InterBase SQL statements. Each TIBDataSet component has properties for a statement to fetch data (typically an SQL SELECT statement), a statement to modify those records, one for inserting records, one for deleting records, and one to refresh the dataset.

TIBDataSet buffers the result set, making it completely scrollable.  Since TIBDataSet is a descendant of TDataSet, it works well with all data-aware components.


TIBDataSet properties

TIBDataSet	Alphabetically	Legend

In TIBDataSet

Filtered

Prepared

Derived from TIBCustomDataSet

BufferChunks

CachedUpdates

CanModify

Database

DataSource

DBHandle

DeleteSQL

ForcedRefresh

GeneratorField

`	InsertSQL

LiveMode

ModifySQL

ParamCheck

Params

Plan

RecNo

RecordCount

RecordSize

RefreshSQL

RowsAffected

SelectSQL

SelectStmtHandle

StatementType

Transaction

TRHandle

UniDirectional

UpdateObject

UpdateRecordTypes

UpdatesPending

Derived fromTDataSet

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

DataSetField

DefaultFields

Designer

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

FilterOptions

Found

IsUniDirectional

Modified

Name

ObjectView

SparseArrays

State

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TIBDataSet properties

TIBDataSet	By object	Legend

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

BufferChunks

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DataSetField

DataSource

DBHandle

DefaultFields

DeleteSQL

Designer

DesignInfo

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

Filtered

FilterOptions

ForcedRefresh

Found

GeneratorField

InsertSQL

IsUniDirectional

LiveMode

Modified

ModifySQL

Name

ObjectView

Owner

ParamCheck

Params

Plan

Prepared

RecNo

RecordCount

RecordSize

RefreshSQL

RowsAffected

SelectSQL

SelectStmtHandle

SparseArrays

State

StatementType

Tag

Transaction

TRHandle

UniDirectional

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TIBDataSet.Filtered

TIBDataSet	See also

Specifies whether or not filtering is active for the dataset.

property Filtered: Boolean;

Description

Check Filtered to determine whether or not dataset filtering is in effect. If Filtered is True, then filtering is active. Otherwise Filtered is False. To apply filter conditions specified in the Filter property or the OnFilterRecord event handler, set Filtered to True.

Note:	When filtering is enabled, user edits to a record may mean that the record no longer meets a filter’s test condition. The next time the record is retrieved from the dataset while the filter is in effect, the record may seem to disappear. If that happens, the next record that passes the filter condition becomes the current record.


TIBDataSet.Params

TIBDataSet	See also

Provides the ability to specify values for a parameterized query.

property Params: TIBXSQLDA;

Description

Use Params to specify values for a parameterized query.

For example:

DataSet1.Params[0].AsInteger := 24

DataSet1.Params.ByName['Field2'].AsString := 'foo'


TIBDataSet.Prepared

TIBDataSet	See also 	Example

Determines whether or not a set of dataset queries is prepared for execution.

property Prepared: Boolean;

Description

Examine Prepared to determine if a set of queries is already prepared for execution. If Prepared is True, the set of queries is prepared, and if Prepared is False, the set of queries is not prepared. While a set of queries need not be prepared before execution, execution performance is enhanced if the set of queries is prepared beforehand, particularly if it is a parameterized set of queries that is executed more than once using the same parameter values.


TIBDataSet events

TIBDataSet	Alphabetically	Legend

Derived from TIBCustomDataSet

AfterDatabaseDisconnect

AfterTransactionEnd

BeforeDatabaseDisconnect

BeforeTransactionEnd

OnUpdateError

OnUpdateRecord

DatabaseFree

TransactionFree

Derived from TDataSet

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TIBDataSet events

TIBDataSet	By object	Legend

AfterCancel

AfterClose

AfterDatabaseDisconnect

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

AfterTransactionEnd

BeforeCancel

BeforeClose

BeforeDatabaseDisconnect

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

BeforeTransactionEnd

DatabaseFree

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnUpdateError

OnUpdateRecord

TransactionFree


TIBDataSet methods

TIBDataSet	Alphabetically	Legend

In TIBDataSet

BatchInput

BatchOutput

ExecSQL

ParamByName

Prepare

UnPrepare

Derived from TIBCustomDataSet

ApplyUpdates

BookmarkValid

CachedUpdateStatus

CancelUpdates

CompareBookmarks

Create

CreateBlobStream

Current

Destroy

FetchAll

GetCurrentRecord

GetFieldData

IsSequenced

Locate

LocateNext

Lookup

Post

RecordModified

RevertRecord

SQLType

Undelete

UpdateStatus

Derived from TDataSet

ActiveBuffer

Append

AppendRecord

Cancel

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBlobFieldData

GetBookmark

GetDetailDataSets

GetDetailLinkFields

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBDataSet methods

TIBDataSet	By object	Legend

ActiveBuffer

AfterConstruction

Append

AppendRecord

ApplyUpdates

Assign

BatchInput

BatchOutput

BeforeDestruction

BookmarkValid

CachedUpdateStatus

Cancel

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CompareBookmarks

ControlsDisabled

Create

CreateBlobStream

Current

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableControls

Dispatch

Edit

EnableControls

ExecSQL

ExecuteAction

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBlobFieldData

GetBookmark

GetCurrentRecord

GetDetailDataSets

GetDetailLinkFields

GetFieldData

GetFieldList

GetFieldNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsImplementorOf

IsLinkedTo

IsSequenced

Last

Locate

LocateNext

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

ParamByName

Post

Prepare

Prior

RecordModified

ReferenceInterface

Refresh

RemoveComponent

RemoveFreeNotification

Resync

RevertRecord

SafeCallException

SetFields

SetSubComponent

SQLType

Translate

Undelete

UnPrepare

UpdateAction

UpdateCursorPos

UpdateRecord

UpdateStatus


TIBDataSet.BatchInput

TIBDataSet	See also

Executes the parameterized query in SQL for input in the referenced input object.

procedure BatchInput(InputObject: TIBBatchInput);

Description

Call BatchInput to execute the parameterized query in SQL for input in the referenced input object.


TIBDataSet.BatchOutput

TIBDataSet	See also

Outputs the selected query in SQL to the referenced OutputObject.

procedure BatchOutput(OutputObject: TIBBatchOutput);

Description

Call BatchOutput to output the selected query in SQL to the referenced OutputObject.


TIBDataSet.ExecSQL

TIBDataSet	See also

Executes the SQL statement that the SelectSQL property specifies when it is not a SELECT statement.

procedure ExecSQL;

Description

Call ExecSQL to execute the main query for this dataset when it is not a SELECT statement. If the value of the SelectSQL property is not set, or if it is set to a SELECT statement, ExecSQL raises an EIBError exception.


TIBDataSet.ParamByName

TIBDataSet	See also

Returns a specified parameter of the SELECT query that fetches this dataset’s data.

function ParamByName(Idx : String) : TIBXSQLVAR;

Description

Call ParamByName to retrieve the object that represents a parameter of the query that fetches this dataset’s data. Use the TIBXSQLVar object this method returns to get or set the parameter value.

Idx is the name of the parameter.


TIBDataSet.Prepare

TIBDataSet	See also 	Example

Prepares all queries in the dataset to be executed.

procedure Prepare;

Description

Call Prepare to prepare all queries in the dataset to be executed.


TIBDataSet.UnPrepare

TIBDataSet	See also

Resets the state of a dataset’s internal queries.

procedure UnPrepare;

Description

Call UnPrepare to reset the state of a dataset’s internal queries.


Hierarchy

TObject

TPersistent

TComponent

TDataSet

TIBCustomDataSet

TIBDataSet


 TIBDataSetUpdateObject

Hierarchy	Properties	Methods	See also

TIBDataSetUpdateObject is the abstract base class for update objects used to update otherwise un-updateable queries when cached updates are enabled.

Unit

IBCustomDataSet

Description

Use TIBDataSetUpdateObject as a base class when creating customized update objects that can be used to update datasets.  TIBDataSetUpdateObject declares a single property and some abstract methods, but provides no implementation details: these must be provided by descendant objects.


TIBDataSetUpdateObject properties

TIBDataSetUpdateObject	Alphabetically	Legend

In TIBDataSetUpdateObject

RefreshSQL

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBDataSetUpdateObject properties

TIBDataSetUpdateObject	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

RefreshSQL

Tag

VCLComObject


TIBDataSetUpdateObject.RefreshSQL

TIBDataSetUpdateObject

Provides the ability to directly access the SQL object encapsulating the RefreshSQL statement.

property RefreshSQL: TIBSQL;

Description

Use RefreshSQL to access the SQL object that encapsulates the RefreshSQL statement.


TIBDataSetUpdateObject methods

TIBDataSetUpdateObject	Alphabetically 	Legend

In TIBDataSetUpdateObject

Create

Destroy

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetParentComponent

GetNamePath

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBDataSetUpdateObject methods

TIBDataSetUpdateObject	By object 	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction


TIBDataSetUpdateObject.Create

TIBDataSetUpdateObject	See also

Creates an instance of a TIBDataSetUpdateObject component.

constructor Create(AOwner:TComponent);

Description

Call Create to create an instance of a TIBDataSetUpdateObject component.


TIBDataSetUpdateObject.Destroy

TIBDataSetUpdateObject	See also

Frees all resources associated with this instance.

destructor Destroy;

Description

Do not call Destroy directly in an application. Usually destruction of objects is handled automatically by Delphi. If an application creates its own instance of an update object, however, the application should call Free, which verifies that the update object is not already freed before calling Destroy.


Hierarchy

TObject

TPersistent

TComponent

TIBDataSetUpdateObject


   TIBEvents

Hierarchy	Properties	Methods	Events	See also

TIBEvents enables applications to respond to posted events.

Unit

IBEvents

Description

Use a TIBEvents component to allow your application to register interest in, and asynchronously handle, events posted by an InterBase server. The InterBase event allows applications to respond to actions and database changes made by other, concurrently running applications, without having to resort to polling the database on a regular basis, or communicating directly with the other applications.

In essence, the TIBEvents component allows an application to say 'I want to be informed when events X, Y and Z occur.” When any of the requested events does occur, the InterBase server notifies the application and OnEventAlert is called.

To use TIBEvents, set the Database property to the component that connects to the InterBase server. Then, use the Events property to indicate the events to which you want to respond. You can set the AutoRegister property to True if you want TIBEvents to automatically register interest in its events when the database component opens a connection, or set the Registered property to True after the connection is open to explicitly register your interest. Finally, write an OnEventAlert event handler to respond when the InterBase event handler informs TIBEvents that an event occurred.


TIBEvents properties

TIBEvents	Alphabetically	Legend

In TIBEvents

AutoRegister

Database

Events

NativeHandle

Registered

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBEvents properties

TIBEvents	By object	Legend

AutoRegister

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DesignInfo

Events

Name

NativeHandle

Owner

Registered

Tag

VCLComObject


TIBEvents.AutoRegister

TIBEvents	See also

Specifies the AutoRegister on which to perform event alerter tasks.

property AutoRegister: Boolean;

Description

When AutoRegister is True, the database automatically registers this component’s events whenever it opens a connection to the InterBase server. When AutoRegister is False, you must explicitly register the events by setting the Registered property to True (or calling RegisterEvents) after the database connection is opened.

Note:	The database always unregisters the events when it closes a connection. By setting AutoRegister to True, you do not need to explicitly re-register interest in the events when the database reopens a connection.


TIBEvents.Database

TIBEvents	See also

Specifies the database on which to perform event alerter tasks.

property Database: TIBDatabase;

Description

Use Database to specify the component that manages a connection to the InterBase server. This connection must be open for TIBEvents to register an interest in its events with the InterBase Event manager on that server.

When you set the Database property, TIBEvents automatically calls the database component’s AddEventNotifier method so that it can register this component’s events when it opens a connection (if AutoRegister is True), and so that it can unregister this component’s events before closing the connection.


TIBEvents.Events

TIBEvents	See also	Legend

Specifies the events to which TIBEvents responds.

property Events: TStrings;

Description

Use the Events property to list events to which the IBEvents component responds.

To add an event use code similar to the following:

IBEvents.Events.Add('EVENT_NAME')

Note:	Event names are case-sensitive.


TIBEvents.NativeHandle

TIBEvents	See also

Supplies the InterBase handle for the database on which events occur.

property NativeHandle: TISC_DB_HANDLE;

Description

Read NativeHandle to get the InterBase handle for the server on which the events occur. This property can be used when working with the InterBase API.


TIBEvents.Registered

TIBEvents	See also

Indicates whether the events in the Events property are registered.

property Registered: Boolean;

Description

Set Registered to True to call RegisterEvents, which registers the events listed by the Events property. Read Registered to determine whether TIBEvents is currently registered (that is, if the InterBase Event manager is notifying this component when any of its events occur.)


TIBEvents events

TIBEvents	Alphabetically	Legend

In TIBEvents

OnError

OnEventAlert


TIBEvents events

TIBEvents	By object	Legend

OnError

OnEventAlert


TIBEvents.OnError

TIBEvents	See also

Occurs when an exception is caught while monitoring events.

type TErrorEvent=procedure(Sender: TObject; ErrorCode : Integer) of object;

property OnError: TEventAlert;

Description

Write an OnError event handler to respond when TIBEvents encounters an exception in the process of monitoring events.

Sender is the TIBEvents component that encounters the exception.

If the exception is an EIBError object, ErrorCode is the InterBase error code it represents. Otherwise, ErrorCode is 0.


TIBEvents.OnEventAlert

TIBEvents	See also

Occurs when an InterBase event is received.

type TEventAlert = procedure( Sender: TObject; EventName: String; EventCount: longint; var CancelAlerts: Boolean)

property OnEventAlert: TEventAlert;

Description

Write an OnEventAlert event handler to take specific actions when an InterBase event is received. EventName contains the name of the most recently received event. EventCount contains the number of EventName events received since OnEventAlert was last called.

Set CancelAlerts to True to cancel interest in any further events. To start receiving events again, call the GetAutoRegister method. You cannot call RegisterEvents, UnRegisterEvents, GetAutoRegister or SetAutoRegister from within an OnEventAlert event handler.

OnEventAlert runs as a separate thread to allow for true asynchronous event processing, however, the IBEvents component provides synchronization code to ensure that only one OnEventAlert event handler executes at any one time.


TIBEvents methods

TIBEvents	Alphabetically	Legend

In TIBEvents

Create

Destroy

GetAutoRegister

RegisterEvents

SetAutoRegister

UnRegisterEvents

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from (TPersistent

Assign

Derived from (TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBEvents methods

TIBEvents	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetAutoRegister

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RegisterEvents

RemoveComponent

RemoveFreeNotification

SafeCallException

SetAutoRegister

SetSubComponent

UnRegisterEvents

UpdateAction


TIBEvents.Create

TIBEvents	See also

Creates an instance of TIBEvents.

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBEvents. TIBEvents objects placed on a form or data module at design time are created automatically.

AOwner specifies the object (typically a form or data module) that is responsible for freeing the TIBEvents instance.


TIBEvents.Destroy

TIBEvents	See also

Destroys an instance of TIBEvents.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TIBEvents object is not nil and only then calls Destroy. Destroy unregisters the events and then frees them.


TIBEvents.GetAutoRegister

TIBEvents	See also

Returns the value of the AutoRegister property.

function GetAutoRegister: Boolean;

Description

GetAutoRegister is the read implementation of the AutoRegister property.


TIBEvents.RegisterEvents

TIBEvents	See also

Registers interest in the events listed by the Events property.

procedure RegisterEvents; virtual;

Description

Call RegisterEvents to register interest in the events listed in the Events property with the InterBase Event Manager. Once this interest is registered, the InterBase Event Manager generates an OnEventAlert event when any of the registered events occurs.

Note:	RegisterEvents is called automatically when you set the Registered property to True or when the AutoRegister property is True and the database connection is open.


TIBEvents.SetAutoRegister

TIBEvents	See also

Sets the AutoRegister property.

procedure SetAutoRegister(const Value: Boolean);;

Description

SetAutoRegister is the write implementation method for the AutoRegister property.

Value is the new value for the AutoRegister property.

When SetAutoRegister changes the AutoRegister property to True, it checks whether the database connection is already open. If so, it calls RegisterEvents to register the events.


TIBEvents.UnRegisterEvents

TIBEvents	See also

Unregisters interest in the events listed by the Events property.

procedure UnRegisterEvents; virtual;

Description

Call UnRegisterEvents to unregister interest in the events in the Events list. When the database closes a connection, or when the IBEvents component is destroyed, UnRegisterEvents is called automatically.


Hierarchy

TObject

TPersistent

TComponent

TIBEvents


AddIndex Example

In the example below, the AddIndex method is used to create an index named NewIndex. This index is based on two fields from the associated table, CustNo and CustName. The index NewIndex incorporates two index options through the TIndexOptions constants ixUnique and ixCaseInsensitive.

IBTable1.AddIndex('NewIndex', 'CustNo;CustName', [ixUnique, ixCaseInsensitive]);


ActivateShadow, SetAsyncMode, SetReadonly, SetReserveSpace Example

The following example shows how to activate the database shadow, set the async and access modes, and reserve disk space for versioning.  Note that the SetReadOnly method is set to False in the beginning; this is to ensure that the other parameters can be set, in case the database has been previously set to read-only.  The call to the Windows API Sleep between each method is to ensure that each service completes before going on to the next.

procedure TForm1.Button1Click(Sender: TObject);

begin

 with IBConfigService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=SYSDBA');

    Params.Add('password=masterkey');

    DatabaseName := 'c:\interbase\tutorial\tutorial.gdb';

    Active := True;

    try

    SetReadOnly(False);

    while IsServiceRunning do Sleep(5);

    if CheckBox1.Checked then

      ActivateShadow;

    while IsServiceRunning do Sleep(5);

    if CheckBox2.Checked then

      SetAsyncMode(True);

    while IsServiceRunning do Sleep(5);

      if CheckBox3.Checked then

      SetReserveSpace(True);

    while IsServiceRunning do Sleep(5);

    if CheckBox4.Checked then

      SetReadonly(True);

    finally

      Active := False;

    end;

  end;

end;


AddLicense, RemoveLicense, Action, ID, Key Example

The following examples show how to add and remove InterBase software activation certificates using the TIBLicensingService.  In the first example, the Action property is set to LicenseAdd, though you could substitute the AddLicense method instead.

procedure TForm1.Button1Click(Sender: TObject);

begin

 with IBLicensingService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Protocol := Local;

    Params.Add('user_name=SYSDBA');

    Params.Add('password=masterkey');

    Active := True;

    try

      Key := Edit1.Text;

      ID := Edit2.Text;

      Action := LicenseAdd;

      ServiceStart;

    finally

    if Active then

      Active := False;

    end;

  end;

end;

procedure TForm1.Button2Click(Sender: TObject);

begin

 with IBLicensingService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=SYSDBA');

    Params.Add('password=masterkey');

    Active := True;

    try

      Key := Edit3.Text;

    finally

      RemoveLicense;

      Active := False;

    end;

  end;

end;


AddUser, DeleteUser Example

The following example shows how to set user information in Edit components, and add the user to the isc4.gdb security database with the AddUser method.  The second example shows how to delete a user based on the UserName field.

procedure TForm1.Button1Click(Sender: TObject);

begin

 with IBSecurityService1 do

  begin

  ServerName := 'Poulet';

  LoginPrompt := False;

  Params.Add('user_name=sysdba');

  Params.Add('password=masterkey');

  Active := True;

    try

      UserName := Edit1.Text;

      FirstName := Edit2.Text;

      MiddleName := Edit3.Text;

      LastName := Edit4.Text;

      UserID := StrToInt(Edit5.Text);

      GroupID := StrToInt(Edit6.Text);

      Password := Edit7.Text;

      AddUser;

    finally

    Active := False;

    end;

  end;

end;

procedure TForm1.Button2Click(Sender: TObject);

begin

 with IBSecurityService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      UserName := Edit1.Text;

      DeleteUser;

    finally

      Edit1.Clear;

      Active := False;

    end;

  end;

end;


BackupFile, DatabaseName, Options, PageBuffers, PageSize, Verbose Example

This example shows how to set up a component that restores a database with the click of a button.  The second example shows how to restore a database from multiple files.

procedure TForm1.Button1Click(Sender: TObject);

begin

 with IBRestoreService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Verbose := True;

      Options := [Replace, UseAllSpace];

      PageBuffers := 3000;

      PageSize := 4096;

      DatabaseName.Add('c:\interbase\tutorial\tutorial.gdb');

      BackupFile.Add('c:\interbase\tutorial\backups\tutor5.gbk');

      ServiceStart;

      Whilenot Eof do

        Memo1.Lines.Add(GetNextLine);

    finally

      Active := False;

    end;

  end;

end;

To restore a database from multiple files:

procedure TForm1.Button3Click(Sender: TObject);

begin

 with IBRestoreService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Verbose := True;

      Options := [Replace, UseAllSpace];

      PageBuffers := 3000;

      PageSize := 4096;

      BackupFile.Add('c:\temp\e1.gbk');

      BackupFile.Add('c:\temp\e2.gbk');

      BackupFile.Add('c:\temp\e3.gbk');

      DatabaseName.Add('c:\interbase\examples\database\employee.gdb');

      ServiceStart;

      Whilenot Eof do

        Memo1.Lines.Add(GetNextLine);

    finally

      Active := False;

    end;

  end;

end;


BatchInput, BatchOutput, InputRawFile,OutputRawFile Example

Assume that you have two IBDatabase connections with an IBSQL component associated with each (named IBSQL1 and IBSQL2, here).  The connections are active and transactions started. The columns described by the select statement and the insert statement must be of the same size and type for a "RAW" transfer.

Here is a raw file conversion example:

procedure TForm1.Button1Click(Sender: TObject);

var

  Filename : String;

  RawOutput : TIBOutputRawFile;

  RawInput : TIBInputRawFile;

begin

  IBSQL1.Sql.Text := 'Select firstname, lastname from people';

  IBSQL2.Sql.Text := 'Insert into people (firstname, lastname) values

(:first, :last)';

  Filename := 'DataFile.RAW';

  RawOutput:= TIBOutputRawFile.Create;

  try

    RawOutput.FileName := FileName;

    IBSQL1.BatchOutput(RawOutput);

  finally

    RawOutput.Free;

  end;

  RawInput := TIBInputRawFile.Create;

  try

    RawInput.FileName := FileName;

    IBSQL2.BatchInput(RawInput);

  finally

    RawInput.Free;

  end;

  IBSQL2.Transaction.CommitRetaining;

end;

{


BringDatabaseOnline, ShutdownDatabase example

The first example shows the simple BringDatabaseOnline method.  The second example shows how to select between the various shutdown options using RadioButton components, while setting the shutdown interval in an Edit box.

procedure TForm1.Button3Click(Sender: TObject);

begin

 with IBConfigService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=SYSDBA');

    Params.Add('password=masterkey');

    DatabaseName := 'c:\interbase\tutorial\tutorial.gdb';

    Active := True;

    try

      BringDatabaseOnline;

    finally

      Active := False;

    end;

  end;

end;

procedure TForm1.Button4Click(Sender: TObject);

begin

with IBConfigService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=SYSDBA');

    Params.Add('password=masterkey');

    DatabaseName := 'c:\interbase\tutorial\tutorial.gdb';

    Active := True;

    try

    if RadioButton1.Checked then

      ShutdownDatabase(Forced, (StrToInt(Edit4.Text)));

    if RadioButton2.Checked then

      ShutdownDatabase(DenyTransaction,(StrToInt(Edit4.Text)));

    if RadioButton3.Checked then

      ShutdownDatabase(DenyAttachment,(StrToInt(Edit4.Text)));

    finally

      Active := False;

    end;

  end;

end;


DatabaseName, Options Example

This example shows a component that backs up a database with the click of a button.  The second example shows how to back up a database to multiple files.

procedure TForm1.Button1Click(Sender: TObject);

begin

 with IBBackupService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Verbose := True;

      Options := [NonTransportable, IgnoreLimbo];

      DatabaseName := 'c:\interbase\examples\database\employee.gdb';

      BackupFile.Add('c:\temp\employee1.gbk');

      ServiceStart;

      While not Eof do

        Memo1.Lines.Add(GetNextLine);

    finally

      Active := False;

    end;

  end;

end;

To back up a database to multiple files:

procedure TForm1.Button2Click(Sender: TObject);

begin

  with IBBackupService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Verbose := True;

      Options := [MetadataOnly, NoGarbageCollection];

      DatabaseName := 'c:\interbase\examples\database\employee.gdb';

      BackupFile.Add('c:\temp\e1.gbk = 2048');

      BackupFile.Add('c:\temp\e2.gbk' = 4096);

      BackupFile.Add('c:\temp\e3.gbk'); ServiceStart;

      While not Eof do

        Memo1.Lines.Add(GetNextLine);

    finally

      Active := False;

    end;

  end;

end;


GlobalAction Example

This example shows how to set the global transaction action using radio buttons.

procedure TForm1.Button4Click(Sender: TObject);

begin

  with IBValidationService1 do

  begin

  ServerName := 'Poulet';

  DatabaseName := 'c:\interbase\tutorial\tutorial.gdb';

  LoginPrompt := False;

  Params.Add('user_name=sysdba');

  Params.Add('password=masterkey');

  Active := True;

    try

      if RadioButton1.Checked then GlobalAction := (CommitGlobal);

      if RadioButton2.Checked then GlobalAction := (RollbackGlobal);

      if RadioButton3.Checked then GlobalAction := (RecoverTwoPhaseGlobal);

      if RadioButton4.Checked then GlobalAction := (NoGlobalAction);

    finally

      Active := False;

    end;

  end;

end;


StartTransaction, Commit, Rollback example

The following procedure illustrates how to apply a dataset’s cached updates to a database in response to a button click:

procedure TForm1.ApplyButtonClick(Sender: TObject);

begin

  IBDatabase1.Open;

  IBTransaction1.StartTransaction;

  Table1.Insert;

  Table1.FieldByName('QUANTITY').AsInteger := StrToInt(Edit1.Text);

  Table1.Post;

  IBTransaction1.Commit;

end;

In the preceding example, you could substitute Rollback for Commit.


Create, CreateBlobStream Example

The following example copies the data in the Notes field of IBTable1 to the Remarks field of IBTable2.

procedure TForm1.Button1Click(Sender: TObject);

var

  Stream1, Stream2 : TIBBlobStream;

begin

  Stream1 := TIBBlobStream.Create(IBTable1Notes);

  try

    Stream1.Mode = bmRead;

    IBTable2.Edit;

    { here’s a different way to create a blob stream }

    { note that with this one, we don’t need a try.. finally clause }

    { because we are not responsible for freeing the stream }

    Stream2 := IBTable2.CreateBlobStream(IBTable2.FieldByName('Remarks'), bmReadWrite);

    Stream2.CopyFrom(Stream1, Stream1.Size);

    IBTable2.Post;

  finally

    Stream1.Free;

  end;

end;


DisplayUser, UserInfo example

The following procedure illustrates how to display user information from the UserInfo record, keyed on the UserName, in response to a button click:

procedure TForm1.Button3Click(Sender: TObject);

begin

 with IBSecurityService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      UserName := Edit1.Text;

      DisplayUser(UserName);

      Edit2.Text := UserInfo[0].FirstName;

      Edit3.Text := UserInfo[0].MiddleName;

      Edit4.Text := UserInfo[0].LastName;

      Edit5.Text := IntToStr(UserInfo[0].UserID);

      Edit6.Text := IntToStr(UserInfo[0].GroupID);

    finally

      Active := False;

    end;

  end;

end;


DisplayUsers, UserInfoCount example

The following procedure illustrates how to display user information for all users from the UserInfo record in response to a button click.  The UserInfoCount property is used to determine the number of users in the security database.

procedure TForm1.Button4Click(Sender: TObject);

var

  I: Integer;

begin

 with IBSecurityService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    Memo1.Lines.Clear;

    try

      DisplayUsers;

      for I := 0 to UserInfoCount - 1 do

      begin

        with UserInfo[i] do

        begin

          Memo1.Lines.Add('User Name : ' + UserName);

          Memo1.Lines.Add('Name: ' + FirstName + ' ' + MiddleName + ' ' + LastName);

          Memo1.Lines.Add('UID: ' + IntToStr(UserId));

          Memo1.Lines.Add('GID: ' + IntToStr(GroupId));

          Memo1.Lines.Add('-----------------------------------');

        end;

      end;

    finally

      Active := False;

    end;

  end;

end;


IBTable Creation Example

The following example shows how to create an InterBase table.

{ Don't overwrite an existing table }

if not IBTable1.Exists then begin

  with IBTable1 do begin

    { The Table component must not be active }

    Active := False;

    { First, give the table a database and a name }

    DatabaseName := 'IBDataBase1';

    TableName := 'CustInfo';

    { Next, describe the fields in the table }

    with FieldDefs do begin

      Clear;

      with AddFieldDef do begin

        Name := 'Field1';

        DataType := ftInteger;

        Required := True;

      end;

      with AddFieldDef do begin

        Name := 'Field2';

        DataType := ftString;

        Size := 30;

      end;

    end;

    { Next, describe any indexes }

    with IndexDefs do begin

      Clear;

      with AddIndexDef do begin

        Name := '';

        Fields := 'Field1';

        Options := [ixPrimary];

      end;

      with AddIndexDef do begin

        Name := 'Fld2Indx';

        Fields := 'Field2';

      end;

    end;

    { Call the CreateTable method to create the table }

    CreateTable;

  end;

end;


Options example

The following procedure illustrates how to set database validation options using check box components.

procedure TForm1.Button3Click(Sender: TObject);

begin

 with IBValidationService1 do

  begin

  ServerName := 'Poulet';

  DatabaseName := 'c:\interbase\tutorial\tutorial.gdb';

  LoginPrompt := False;

  Params.Add('user_name=sysdba');

  Params.Add('password=masterkey');

  Active := True;

  Options := [];

    try

      if CheckBox1.Checked then Options := Options + [LimboTransactions];

      if CheckBox2.Checked then Options := Options + [CheckDB];

      if CheckBox3.Checked then Options := Options + [IgnoreChecksum];

      if CheckBox4.Checked then Options := Options + [KillShadows];

      if CheckBox5.Checked then Options := Options + [MendDB];

      if CheckBox6.Checked then Options := Options + [SweepDB];

      if CheckBox7.Checked then Options := Options + [ValidateDB];

      if CheckBox8.Checked then Options := Options + [ValidateFull];

    finally

      Active := False;

    end;

  end;

end;


Prepare, ExecProc Example

The following code executes the stored procedure:

IBStoredProc1.Prepare;

try

  IBStoredProc1.Params[0].AsString := Edit1.Text;

  IBStoredProc1.ExecProc;

  Edit2.Text := IBStoredProc1.ParamByName('FinalValue').AsString;

finally

  IBStoredProc1.UnPrepare;

end;


Prepare, Prepared example

if not IBDataSet1.Prepared then

begin

  IBDataSet1.Close;

  IBDataSet1.Prepare;

  IBDataSet1.Open;

end;


Prepare, Prepared example

if not IBSQL1.Prepared then

begin

  IBSQL1.Close;

  IBSQL1.Prepare;

  IBSQL1.Open;

end;


SQL, ExecSQL Example

IBQuery1.Close;

IBQuery1.SQL.Clear;

IBQuery1.SQL.Add('Delete from Country where Name = ''Argentina''');

IBQuery1.ExecSQL;


ParamByName Example

var Buffer: Pointer;

begin

  { Allocate enough space to hold the CustNo data }

  GetMem(Buffer, IBQuery1.ParamByName('CustNo').GetDataSize);

  try

  { Retrieve the data }

    IBQuery1.ParamByName('CustNo').GetData(Buffer);

    {  now do something with the data }

  finally

    FreeMem(MyBuffer);

  end;

end;


ParamByName Example

StoredProc1.ParamByName('DNO').AsString := Edit1.Text;

StoredProc1.Prepare;

StoredProc1.ExecProc;

Edit2.Text := FloatToStr(StoredProc1.ParamByName('TOT').AsFloat);


CurrentMemory, DBFileName, Fetches, UserNames Example

Use this example as a guideline on how to use any of the TIBDatabaseInfo properties.

procedure TForm1.Button1Click(Sender: TObject);

var

  I: Integer;

begin

with IBDatabaseInfo1 do

  begin

    for I := 0 to UserNames.Count - 1 do

      Memo1.Lines.Add(UserNames[I]);

    Memo1.Lines.Add(DBFileName);

    Memo1.Lines.Add(IntToStr(Fetches));

    Memo1.Lines.Add(IntToStr(CurrentMemory));

  end;

end;


Options, DatabaseName Example
DatabaseName, Options Example

The following example shows how to display database statistics with the click of a button:

procedure TForm1.Button1Click(Sender: TObject);

begin

 with IBStatisticalService1 do

  begin

    ServerName := 'Poulet';

    DatabaseName := 'C:\interbase\tutorial\tutorial.gdb';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    ServiceStart;

    try

      Options := [DataPages, DbLog];

      Whilenot Eof do

        Memo1.Lines.Add(GetNextLine);

    finally

      Active := False;

    end;

  end;

end;


IndexDefs, IndexName Example
IndexDefs, IndexName

This example uses the IndexName property to sort the records in a table on the CustNo and OrderNo fields.

IBTable1.Active := False;

{ Get the current available indices }

IBTable1.IndexDefs.Update;

{ Find one on Customer and Order Numbers ('CustNo' and 'OrderNo') }

for I := 0 to IBTable1.IndexDefs.Count - 1 do

  if Table1.IndexDefs[I].Fields = 'CustNo;OrderNo' then

    { set that index as the current index for the table }

    IBTable1.IndexName := IBTable1.IndexDefs[I].Name;

IBTable1.Active := True;


IndexFields, IndexFieldCount Example

The following code calculates the total length of the index and assigns it to the variable TotalLen.

TotalLen := 0;

with IBTable1 do

  for I := 0 to IndexFieldCount - 1 do

    Inc(TotalLen, IndexFields[I].DataSize);


ParamCount, DataType, StrToIntDef, AsXXX Example
ParamCount Example

This example fills in the parameters of a query from the entries of a list box.

var

  I: Integer;

  ListItem: string;

begin

  for I := 0 to IBQuery1.ParamCount - 1 do

  begin

    ListItem := ListBox1.Items[I];

    case IBQuery1.Params[I].DataType of

      ftString:

        IBQuery1.Params[I].AsString := ListItem;

      ftSmallint:

        IBQuery1.Params[I].AsSmallInt := StrToIntDef(ListItem, 0);

      ftInteger:

        IBQuery1.Params[I].AsInteger := StrToIntDef(ListItem, 0);

      ftWord:

        IBQuery1.Params[I].AsWord := StrToIntDef(ListItem, 0);

      ftBoolean:

        begin

          if ListItem = 'True' then

            IBQuery1.Params[I].AsBoolean := True

          else

            IBQuery1.Params[I].AsBoolean := False;

        end;

      ftFloat:

        IBQuery1.Params[I].AsFloat := StrToFloat(ListItem);

      ftCurrency:

        IBQuery1.Params[I].AsCurrency := StrToFloat(ListItem);

      ftBCD:

        IBQuery1.Params[I].AsBCD := StrToCurr(ListItem);

      ftDate:

        IBQuery1.Params[I].AsDate := StrToDate(ListItem);

      ftTime:

        IBQuery1.Params[I].AsTime := StrToTime(ListItem);

      ftDateTime:

        IBQuery1.Params[I].AsDateTime := StrToDateTime(ListItem);

    end;

  end;

end;


ParamCount, Params Example

{ Set all input parameters to an empty string }

with IBStoredProc1 do

  for I := 0 to ParamCount - 1 do

    if (Params[I].ParamType = ptInput) or

       (Params[I].ParamType = ptInputOutput) then

      Params[I].AsString := '';


Params Example

The following code runs an insert query to add a record for Lichtenstein into the country table.

IBQuery2.SQL.Clear;

IBQuery2.SQL.Add('INSERT INTO COUNTRY (NAME, CAPITAL, POPULATION)');

IBQuery2.SQL.Add('VALUES (:Name, :Capital, :Population)');

IBQuery2.Params[0].AsString := 'Lichtenstein';

IBQuery2.Params[1].AsString := 'Vaduz';

IBQuery2.Params[2].AsInteger := 420000;

IBQuery2.ExecSQL;


Prepared, Prepare Example

if not IBQuery1.Prepared then

begin

  IBQuery1.Close;

  IBQuery1.Prepare;

  IBQuery1.Open

end;


FetchConfigParams, ConfigParams, ConfigFileData Example

The following example shows how to use the ConfigParams option along with the FetchConfigParams method to display the parameters and values in the ibconfig file on the server (isc_config on UNIX and Linux). ConfigParams displays the location of the InterBase executable, the lock file, the message file, and the security database. It also displays the configuration file parameters. This example also shows how to use the ConfigFileData array to display server key values.

procedure TForm1.Button1Click(Sender: TObject);

var

  I: Integer;

  st1: string;

begin

 with IBServerProperties1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Options := [ConfigParameters];

      FetchConfigParams;

      Label1.Caption := 'Base File = ' + ConfigParams.BaseLocation;

      Label2.Caption := 'Lock File = ' + ConfigParams.LockFileLocation;

      Label3.Caption := 'Message File = ' + ConfigParams.MessageFileLocation;

      Label4.Caption := 'Security Database = ' + ConfigParams.SecurityDatabaseLocation;

      for I:= 0 to High(ConfigParams.ConfigFileData.ConfigFileValue) do

      begin

        case ConfigParams.ConfigFileData.ConfigFileKey[i] of

        ISCCFG_IPCMAP_KEY:  st1 := 'IPCMAP_KEY';

        ISCCFG_LOCKMEM_KEY:  st1 := 'LOCKMEM_KEY';

        ISCCFG_LOCKSEM_KEY:  st1 := 'LOCKSEM_KEY';

        ISCCFG_LOCKSIG_KEY:  st1 := 'LOCKSIG_KEY';

        ISCCFG_EVNTMEM_KEY:  st1 := 'EVNTMEM_KEY';

        ISCCFG_DBCACHE_KEY:  st1 := 'DBCACHE_KEY';

        ISCCFG_PRIORITY_KEY: st1 := 'PRIORITY_KEY';

        ISCCFG_MEMMIN_KEY: st1 := 'MEMMIN_KEY';

        ISCCFG_MEMMAX_KEY: st1 := 'MEMMAX_KEY';

        ISCCFG_LOCKORDER_KEY: st1 := 'LOCKORDER_KEY';

        ISCCFG_ANYLOCKMEM_KEY: st1 := 'ANYLOCKMEM_KEY';

        ISCCFG_ANYLOCKSEM_KEY: st1 := 'ANYLOCKSEM_KEY';

        ISCCFG_ANYLOCKSIG_KEY:  st1 := 'ANYLOCKSIG_KEY';

        ISCCFG_ANYEVNTMEM_KEY: st1 := 'ANYEVNTMEM_KEY';

        ISCCFG_LOCKHASH_KEY: st1 := 'LOCKHASH_KEY';

        ISCCFG_DEADLOCK_KEY: st1 := 'DEADLOCK_KEY';

        ISCCFG_LOCKSPIN_KEY: st1 := 'LOCKSPIN_KEY';

        ISCCFG_CONN_TIMEOUT_KEY: st1 := 'CONN_TIMEOUT_KEY';

        ISCCFG_DUMMY_INTRVL_KEY: st1 := 'DUMMY_INTRVL_KEY';

        end;

        Memo1.Lines.Add(st1 + ' = ' +  IntTostr(ConfigParams.ConfigFileData.ConfigFileValue[i]));

      end;

    finally

      Active := False;

    end;

  end;

end;


SetPageBuffers, SetDBSqlDialect, SetSweepInterval Example
SetDBSqlDialect, SetPageBuffers, SetSweepInterval Example

The following example shows how to set the database SQL dialect, page buffers, and sweep interval.  Note that the SetReadOnly method is set to False; this is to ensure that the other parameters can be set, in case the database has been previously set to read-only.  The call to the Windows API Sleep(5) between each method is to ensure that each service completes before going on to the next.

procedure TForm1.Button2Click(Sender: TObject);

begin

 with IBConfigService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=SYSDBA');

    Params.Add('password=masterkey');

    DatabaseName := 'c:\interbase\tutorial\tutorial.gdb';

    Active := True;

    try

      SetReadOnly(False);

      while IsServiceRunning do Sleep(5);

      SetDBSqlDialect(StrtoInt(Edit1.Text));

      while IsServiceRunning do Sleep(5);

      SetPageBuffers(StrtoInt(Edit2.Text));

      while IsServiceRunning do Sleep(5);

      SetSweepInterval(StrtoInt(Edit3.Text));

    finally

      Active := False;

    end;

  end;

end;


Eof, GetNextLine Example

The following example shows how to display the contents of the interbase.log file with the click of a button.

procedure TForm1.Button1Click(Sender: TObject);

begin

 with IBLogService1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    ServiceStart;

    try

      Whilenot Eof do

        Memo1.Lines.Add(GetNextLine);

    finally

      Active := False;

    end;

  end;

end;


UpdateRecordTypes, RevertRecord example

With minor coding, UpdateRecordTypes and RevertRecord can be used to undelete records when cached updates are enabled, as the following procedure demonstrates:

procedure UndeleteAll(DataSet: TIBCustomDataSet);

begin

  with DataSet do

  begin

  UpdateRecordTypes := [cusDeleted]; {make only deleted records visible}

   try

    First; {move to beginning of dataset}

    whilenot EOF do

      begin

      Undelete; {undelete the current record}

      Next; {move to the next record}

      end;

  UpdateRecordTypes := [cusUninserted];

   try

    First; {move to beginning of dataset}

    whilenot EOF do

      begin

      RevertRecord; {undelete the current record}

      Next; {move to the next record}

      end;

   finally

    UpdateRecordTypes := [cusDeleted, cusModified, cusInserted, cusUninserted, cusUnmodified];

   end;

  end;

end;


FetchDatabaseInfo, DatabaseInfo Example

procedure TForm1.Button1Click(Sender: TObject);

var

  I: Integer;

begin

with IBServerProperties1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Options := [Database];

      FetchDatabaseInfo;

      Label1.Caption := 'Number of Attachments = ' + IntToStr(DatabaseInfo.NoOfAttachments);

      Label2.Caption := 'Number of Databases = ' + IntToStr(DatabaseInfo.NoOfDatabases);

      for I:= 0 to High(DatabaseInfo.DbName) do

        Memo1.Lines.Add(DatabaseInfo.DbName[i]);

    finally

      Active := False;

    end;

  end;

end;


FetchVersionInfo, VersionInfo Example

procedure TForm1.Button1Click(Sender: TObject);

begin

with IBServerProperties1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Options := [Version];

      FetchVersionInfo;

      Label1.Caption := 'Server Version = ' + VersionInfo.ServerVersion;

      Label2.Caption := 'Server Implementation = ' + VersionInfo.ServerImplementation;

      Label3.Caption := 'Service Version = ' + IntToStr(VersionInfo.ServiceVersion);

    finally

      Active := False;

    end;

  end;

end;


FetchLicenseInfo, LicenseInfo Example

procedure TForm1.Button1Click(Sender: TObject);

var

  I: Integer;

begin

with IBServerProperties1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Options := [License];

      FetchLicenseInfo;

      Label1.Caption := 'Licensed Users = ' + IntToStr(LicenseInfo.LicensedUsers);

      for I:= 0 to High(LicenseInfo.Key) do

        Memo1.Lines.Add(LicenseInfo.Key[i] + ':' + LicenseInfo.ID[i] + ':' + LicenseInfo.Desc[i]);

    finally;

      Active := False;

    end;

  end;

end;


FetchLicenseMaskInfo, LicenseMaskInfo Example

procedure TForm1.Button1Click(Sender: TObject);

begin

with IBServerProperties1 do

  begin

    ServerName := 'Poulet';

    LoginPrompt := False;

    Params.Add('user_name=sysdba');

    Params.Add('password=masterkey');

    Active := True;

    try

      Options := [LicenseMask];

      FetchLicenseMaskInfo;

      Label1.Caption := 'License Mask = ' + IntToStr(LicenseMaskInfo.LicenseMask);

      Label2.Caption := 'Capability Mask = ' + IntToStr(LicenseMaskInfo.CapabilityMask);

    finally

      Active := False;

    end;

  end;

end;


 TIBExtract

Hierarchy	Properties	Methods	See also

TIBExtract fetches metadata from an InterBase server.

Unit

IBExtract

Description

Use a TIBExtract component to fetch metadata information such as a list of tables, views, roles, indexes, and so on. To use TIBExtract,

1. Set the Database and Transaction properties to specify the database from which to fetch information and to provide a transaction to use when fetching that information.

2. Call the ExtractObject method, indicating the type of metadata you want to fetch.

3. Read the extracted information from the Items property.


TIBExtract properties

TIBExtract	Alphabetically	Legend

In TIBExtract

Database

DatabaseInfo

Items

ShowSystem

Transaction

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBExtract properties

TIBExtract	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DatabaseInfo

DesignInfo

Items

Name

Owner

ShowSystem

Tag

Transaction

VCLComObject


TIBExtract.Database

TIBExtract	See also

Specifies the database from which to fetch metadata.

property Database: TIBDatabase;

Description

Use Database to specify the database from which to fetch metadata.


TIBExtract.DatabaseInfo

TIBExtract	See also

Represents information about the associated database.

property DatabaseInfo: TIBDatabaseInfo;

Description

Read DatabaseInfo to obtain information about the database that is specified by the Database property. DatabaseInfo provides a variety of information about the database itself, such as the version of the online disk structure (ODS) used by the attachment, the number of database cache buffers allocated, the number of database pages read from or written to, and write-ahead log information.


TIBExtract.Items

TIBExtract	See also

Lists the information that the TIBExtract object has fetched from the database server.

property Items: TStrings;

Description

Use the Items property to read the metadata information that was fetched from the database server. The ExtractObject method writes information to the Items property every time you call it.

Tip:	TIBExtract does not clear the Items property when you make a new call to ExtractObject. You may want to clear this list of strings between calls to ExtractObject so that the list does not get too long.


TIBExtract.ShowSystem

TIBExtract

Reserved for future use.

property ShowSystem: Boolean;

Description

Currently, ShowSystem is not implemented.


TIBExtract.Transaction

TIBExtract	See also

Specifies the transaction to use when fetching metadata from the server.

property Transaction: TIBTransaction;

Description

Set Transaction to specify a transaction to use when fetching metadata from the server. The ExtractObject method executes all calls to the server within the context of this transaction.


TIBExtract methods

TIBExtract	Alphabetically	Legend

In TIBExtract

Create

Destroy

ExtractObject

GetArrayField

GetCharacterSets

GetFieldType

Notification

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from (TPersistent

Assign

Derived from (TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBExtract methods

TIBExtract	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

ExtractObject

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetArrayField

GetCharacterSets

GetFieldType

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

Notification

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction


TIBExtract.ExtractObject

TIBExtract	See also

Fetches specified metadata from the InterBase server and writes it to the Items property.

type

  TExtractObjectTypes = (eoDatabase, eoDomain, eoTable, eoView, eoProcedure, eoFunction, eoGenerator, eoException, eoBLOBFilter, eoRole, eoTrigger, eoForeign, eoIndexes, eoChecks, eoData);

  TExtractType = (etDomain, etTable, etRole, etTrigger, etForeign, etIndex, etData, etGrant, etCheck, etAlterProc);

  TExtractTypes = Set of TExtractType;

procedure ExtractObject(ObjectType : TExtractObjectTypes; ObjectName : String = ''; ExtractTypes : TExtractTypes = []);;

Description

Call ExtractObject to fetch metadata from the database specified by the Database property and write it to the Items property.

ObjectType indicates the desired type of metadata. It can be any of the following values:

Value	Meaning

eoDatabase	Lists all objects defined on the database. This is the list that would be fetched by calling ExtractObject for each of the other object types in turn (plus the create database command that is supported), with no limits placed by the ObjectName and ExtractTypes parameters.

eoDomain	Lists all domains. If ExtractTypes includes etTable, this list includes only domains for the table specified by ObjectName.

eoTable	If ObjectName is an empty string, lists all the tables defined on the server. If ObjectName is non-empty, lists all the columns and types of the table named by ObjectName, plus any information specified by ExtractTypes that pertains to that table. This can include domains (etDomain), indexes (etIndex), foreign key constrains (etForeign), check constraings (etCheck), triggers (etTrigger), user permissions (etGrant), and data (etData).

eoView	If ObjectName is an empty string, lists the text of all views. Otherwise, lists the text of the view named by the ObjectName parameter.

eoProcedure	If ObjectName is an empty string, lists all the stored procedures. Otherwise, lists the text of the stored procedure named by the ObjectName parameter. To handle the situation where procedures reference each other, ExtractObject creates dummy procedures of the correct name and then alters these to their correct form. If ExtractTypes includes etAlterProc, only the corrected form is fetched.

eoFunction	Lists all external functions. If ObjectName is non-empty, the list is filtered to include only those functions that match the specified name.

eoGenerator	Lists all non-system generators. If ObjectName is non-empty, the list is filtered to include only those generators that match the specified name.

eoException	Lists all exceptions that the database defines. If ObjectName is non-empty, the list is filtered to include only those exceptions that match the specified name.

eoBLOBFilter	Lists all blob filters. If ObjectName is non-empty, the list is filtered to include only those filters whose function name matches the specified name.

eoRole	Lists all roles. If ObjectName is non-empty, the list is filtered to include only those roles whose name matches the specified string.

eoTrigger	If ExtractTypes includes etTable, lists all triggers defined for the table specified by ObjectName. Otherwise, lists all triggers or, if ObjectName is nonempty, all triggers that match the string specified by ObjectName.

eoForeign	If ExtractTypes includes etTable, lists all foreign key constraints that pertain to the table specified by ObjectName. Otherwise, list all foreign key constraints, or, if ObjectName is nonempty, all foreign key constraints that have a name that matches ObjectName.

eoIndexes	If ExtractTypes includes etTable, lists all indexes defined on the table specified by ObjectName. Otherwise, lists all indexes, or, if ObjectName is nonempty, all indexes that have a name that matches ObjectName.

eoChecks	If ExtractTypes includes etTable, lists all non-foreign check constraints on the table specified by ObjectName. Otherwise, lists all non-foreign check constraints, or, if ObjectName is nonempty, all check constraints that have a name that matches ObjectName.

eoData	Lists all the data in the object named by the ObjectName parameter.

ObjectName specifies the name of an object (such as a table or stored procedure) about which you want information. The type of this object and the way it limits the fetched information depends on the values of ObjectType and ExtractTypes.

ExtractTypes modifies the interpretation of ObjectType, to filter the type of information fetched. See the table of ObjectType values for details.


TIBExtract.Create

TIBExtract	See also

Creates an instance of TIBExtract.

constructor Create(AOwner: TComponent); override;

Description

Call Create to create an instance of TIBExtract at runtime. TIBExtract components added to forms or data modules at design time are created automatically.

AOwner specifies the component that is responsible for freeing the TIBExtract instance. If AOwner is a TIBDatabase component, it is used to initialize the Database property.


TIBExtract.Destroy

TIBExtract	See also

Destroys an instance of TIBExtract.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TIBExtract object is not already freed and only then calls Destroy.

There is no need to explicitly free a TIBExtract instance that is created with an Owner. The component’s Owner handles the task of freeing it.


TIBExtract.GetArrayField

TIBExtract

Returns the dimensions of an array field as a printable string.

function GetArrayField(FieldName : String) : String;

Description

GetArrayField returns the dimensions of the array field with the name specified by the FieldName parameter. The resulting string has the form

[lower:upper, lower:upper,..]


TIBExtract.GetCharacterSets

TIBExtract

Returns a specified character set and collation order as a printable string.

function GetCharacterSets(CharSetId, Collation : Short; CollateOnly : Boolean) : String;

Description

GetCharacterSets looks up a specified character set and collation order, and returns their names.

CharSetId is the identifier of the desired character set.

Collation is the identifier of the desired collation order.

CollateOnly indicates that the return string should include the name of the collation order but not the name of the character set.


TIBExtract.GetFieldType

TIBExtract

Returns the full description of a specified field type as a printable string.

function GetFieldType(FieldType, FieldSubType, FieldScale, FieldSize, FieldPrec, FieldLen : Integer) : String;

Description

GetFieldType returns the string description with the specified field type, subtype, scale, size, precision, and length.


TIBExtract.Notification

TIBExtract	See also

Responds to notifications when components are created or freed.

procedure Notification(AComponent: TComponent; Operation: TOperation); override;

Description

Notification is called automatically when objects are created or freed so that TIBExtract can make any necessary adjustments.

AComponent is the component that was just created or that is about to be destroyed.

Operation indicates whether AComponent was just created (opInsert) or is about to be freed (opRemove).

In TIBExtract, Notification checks whether the components that implement the Database and Transaction properties are about to be freed, and if so, sets the appropriate property to nil.


Hierarchy

TObject

TPersistent

TComponent

TIBExtract


 TIBGeneratorField

Hierarchy	Properties	Methods 	See also

TIBGeneratorField calls the server to generate values for a field in an IB dataset.

Unit

IBCustomDataSet

Description

Assign an instance of TIBGeneratorField as the value of a dataset’s GeneratorField property to indicate that the value of a specified field in the dataset can be generated by the server.

Use the Field property to specify the field whose value is generated by the TIBGeneratorField object. Use the Generator and IncrementBy properties to specify how the server should generate field values. Use the ApplyEvent property to indicate when the TIBGeneratorField should call the server to generate field values.


TIBGeneratorField properties

TIBGeneratorField	Alphabetically	Legend

In TIBGeneratorField

ApplyEvent

Field

Generator

IncrementBy

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBGeneratorField properties

TIBGeneratorField	By object	Legend

ApplyEvent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Field

Generator

IncrementBy

Name

Owner

Tag

VCLComObject


TIBGeneratorField.ApplyEvent

TIBGeneratorField	See also

Indicates when the TIBGeneratorField instance calls the server to generate a value for the associated field.

type TIBGeneratorApplyEvent = (gamOnNewRecord, gamOnPost, gamOnServer);

property ApplyEvent : TIBGeneratorApplyEvent;

Description

Set TIBGeneratorApplyEvent to indicate when the server generates field values using this generator. ApplyEvent has one of the following values:

Value	Meaning

gamOnNewRecord	The dataset calls the server to generate the field value immediately after it inserts or appends a new record (before the OnNewRecord event).

gamOnPost	The dataset calls the server to generate the field value immediately before it posts a record to the server (before the BeforePost event).

gamOnServer	The dataset does not need to call the server to generate field values: the server generates these values automatically. When ApplyEvent is gamOnServer, TIBGeneratorField serves primarily to ensure that the user is not required to enter a value in the field.

Note:	Regardless of the value of ApplyEvent, applications can generate the field value at any time by calling the Apply method.


TIBGeneratorField.Field

TIBGeneratorField	See also

Specifies the field whose value the TIBGeneratorField object generates.

property Field : string;

Description

Set Field to the name of the field whose value the generator sets. When the event specified by the ApplyEvent property occurs, or when an application calls the Apply method, the TIBGeneratorField object calls the server to generate a field value and assigns that value to the specified field.

Field must be the FieldName property of one of the fields in the associated dataset’s Fields property list. The TIBGenratorField object is associated with a dataset when it is the value of that dataset’s GeneratorField property.


TIBGeneratorField.Generator

TIBGeneratorField	See also

Names the generator on the server that TIBGeneratorField calls to generate field values.

property Generator : string;

Description

TIBGeneratorField uses Generator, along with the IncrementBy property, to generate the SQL statement that fetches the generated field value. The generated SQL statement has the form

SELECT GEN_ID(Generator, IncrementBy) FROM RDB$DATABASE

Where ‘Generator’ is replaced by the value of Generator and ‘IncrementBy’ is replaced by the value of IncrementBy.


TIBGeneratorField.IncrementBy

TIBGeneratorField	See also

Names the amount by which a generator on the server increments the value of the associated field.

property IncrementBy : Integer;

Description

TIBGeneratorField uses IncrementBy, along with the Generator property, to generate the SQL statement that fetches the generated field value. The generated SQL statement has the form

SELECT GEN_ID(Generator, IncrementBy) FROM RDB$DATABASE

Where ‘Generator’ is replaced by the value of Generator and ‘IncrementBy’ is replaced by the value of IncrementBy.


TIBGeneratorField methods

TIBGeneratorField	Alphabetically	Legend

In TIBGeneratorField

Apply

Assign

Create

ValueName

Derived from (TPersistent

Destroy

GetNamePath

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBGeneratorField methods

TIBGeneratorField	By object	Legend

AfterConstruction

Apply

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

ValueName


TIBGeneratorField.Apply

TIBGeneratorField	See also

Calls the generator on the server to generate a field value and assigns it to the associated field.

procedure Apply;

Description

Call Apply to fetch the server-generated value for the field identified by the Field property and assign that value to the field.

If the ApplyEvent property is not gamOnServer, the associated dataset calls Apply automatically at the point indicated by ApplyEvent.


TIBGeneratorField.Assign

TIBGeneratorField	See also

Copies the properties of another object.

procedure Assign(Source: TPersistent); override;

Description

Call Assign to copy the properties of another object on to this TIBGeneratorField instance. TIBGeneratorField overrides the inherited method to copy the Field, Generator, IncrementBy and ApplyEvent properties of the object specified by Source if it is another TIBGeneratorField instance.

If Source is not another TIBGeneratorField, Assign calls the inherited method, which allows any objects that know how to assign themselves to a TIBGeneratorField to copy their properties.


TIBGeneratorField.Create

TIBGeneratorField	See also

Creates an instance of TIBGeneratorField.

constructor Create(ADataSet: TIBCustomDataSet);

Description

Do not create instances of TIBGeneratorField. This class is designed to work with an IB dataset and is automatically created by the dataset to implement its GeneratorField property.

ADataSet is the dataset that creates the TIBGeneratorField instance and which contains the field whose value the generator field assigns.


TIBGeneratorField.ValueName

TIBGeneratorField	See also

Returns a string that describes the value that the IB generate fetches.

function ValueName: string;

Description

ValueName returns a string of the form

Generator -> Field By IncrementBy

where Generator is the value of the Generator property, Field is the value of the Field property, and IncrementBy is the value of the IncrementBy property.


Hierarchy

TObject

TPersistent

TIBGeneratortField

TIBGeneratorField


 TIBInputDelimitedFile

Hierarchy	Properties	Methods	See also

TIBInputDelimitedFile performs batch input of data from delimited files.

Unit

Description

Use a TIBInputDelimitedFile object to perform batch input of data from delimited files.


TIBInputDelimitedFile properties

TIBInputDelimitedFile	Alphabetically	Legend

In TIBInputDelimitedFile

ColDelimiter

ReadBlanksAsNull

RowDelimiter

SkipTitles

Derived from TIBBatch

Columns

FileName

Params


TIBInputDelimitedFile properties

TIBInputDelimitedFile	By object	Legend

ColDelimiter

Columns

FileName

Params

ReadBlanksAsNull

RowDelimiter

SkipTitles


TIBInputDelimitedFile.ColDelimiter

TIBInputDelimitedFile	See also

Sets the column delimiter for the input file.

property ColDelimiter: String;

Description

Use ColDelimiter to set the column delimiter (either Tab-Ctrl-F or |~) for the input file.


TIBInputDelimitedFile.ReadBlanksAsNull

TIBInputDelimitedFile	See also

Reads blank spaces in the input file as null characters.

property ReadBlanksAsNull: Boolean;

Description

Set ReadBlanksAsNull to True read blank spaces as null characters in the input file.


TIBInputDelimitedFile.RowDelimiter

TIBInputDelimitedFile	See also

Sets the row delimiter for the input file.

property RowDelimiter: String;

Description

Use RowDelimiter to set the column delimiter (either Tab-Ctrl-F or |~) for the input file.


TIBInputDelimitedFile.SkipTitles

TIBInputDelimitedFile	See also

Skips the first record of a delimited file.

property SkipTitles: Boolean;

Description

Set SkipTitles to True to treat the first record of a delimited file as titles and skip it.  Field titles are not useful in batch inputs, and this property allows you to skip them.


TIBInputDelimitedFile methods

TIBBatchInput	Alphabetically	Legend

In TIBInputDelimitedFile

Destroy

GetColumn

ReadParameters

ReadyFile

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBInputDelimitedFile methods

TIBInputDelimitedFile	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetColumn

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadParameters

ReadyFile

SafeCallException


TIBInputDelimitedFile.Destroy

TIBInputDelimitedFile	See also

Destroys the instance of TIBInputDelimitedFile.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TIBInputDelimitedFile object is not already freed and only then calls Destroy.


TIBInputDelimitedFile.GetColumn

TIBInputDelimitedFile	See also

Returns the contents of a column.

function GetColumn: var Col: String): Integer;

Description

Call GetColumn to return the contents of a column in the extended SQL descriptor area (XSQLDA).


TIBInputDelimitedFile.ReadParameters

TIBInputDelimitedFile	See also

Reads the input parameters of the XSQLDA.

function ReadParameters: Boolean;

Description

Call ReadParameters to read the input parameters of the extended SQL descriptor area (XSQLDA).


TIBInputDelimitedFile.ReadyFile

TIBInputDelimitedFile	See also

Prepares the output for the XSQLDA.

procedure ReadyFile;

Description

Call ReadyFile to prepare the output for the extended SQL descriptor area (XSQLDA).


Hierarchy

TObject

TIBBatch

TIBBatchInput

TIBInputDelimitedFile


 TIBInputRawFile

Hierarchy	Properties	Methods	See also 	Example

TIBInputRawFile inputs data from a raw file.

Unit

Description

Use a TIBInputRawFile object input data from a raw file.  A raw file is the equivalent to InterBase external file output.  Raw files are not limited to a straight character format.


TIBInputRawFile properties

TIBInputRawFile	Alphabetically	Legend

Derived from TIBBatch

Columns

FileName

Params


TIBInputRawFile properties

TIBInputRawFile	By object	Legend

Columns

FileName

Params


TIBInputRawFile methods

TIBInputRawFile	Alphabetically	Legend

In TIBInputRawFile

Destroy

ReadParameters

ReadyFile

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBInputRawFile methods

TIBBatch	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadParameters

ReadyFile

SafeCallException


TIBInputRawFile.Destroy

TIBInputRawFile	See also

Destroys the instance of TIBInputRawFile.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TIBInputRawFile object is not already freed and only then calls Destroy.


TIBInputRawFile.ReadParameters

TIBInputRawFile	See also

Reads the XSQLDA input parameters.

function ReadParameters: Boolean;

Description

Call ReadParameters to read the input parameters of the extended SQL descriptor area (XSQLDA).


TIBInputRawFile.ReadyFile

TIBInputRawFile	See also

Prepares the output for the XSQLDA.

procedure ReadyFile;

Description

Call ReadyFile to prepare the output for the extended SQL descriptor area (XSQLDA).


Hierarchy

TObject

TIBBatch

TIBBatchInput

TIBInputRawFile


 TIBInstall

Hierarchy	Properties	Methods	Events	See also

Use TIBInstall to set up an InterBase installation component.

Unit

IBInstall

Description

Use TIBInstall to set up an InterBase installation component.

Note: To use this component, you must install InterBase 6 and you must place ibinstall.dll in the path.


TIBInstall properties

TIBInstall	Alphabetically	Legend

In TIBInstall

DestinationDirectory

InstallOptions

SourceDirectory

SuggestedDestination

UnInstallFile

Derived from TIBSetup

ErrorContext

MsgFilePath

Progress

RebootToComplete

StatusContext

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBInstall properties

TIBInstall	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

DestinationDirectory

ErrorContext

InstallOptions

MsgFilePath

Name

Owner

Progress

RebootToComplete

SourceDirectory

StatusContext

SuggestedDestination

Tag

UnInstallFile

VCLComObject


TIBInstall.DestinationDirectory

TIBInstall	See also

Sets or returns the installation target path.

property DestinationDirectory: String;

Use DestinationDirectory to set or returns the installation target path.  Initially, this will be the same as the SuggestedDestination.

Note: You must install InterBase 6 to use this feature.


TIBInstall.InstallOptions

TIBInstall	See also

Sets or displays the installation options.

property InstallOptions: TInstallOptions;

Use InstallOptions to set or display the installation options (TInstallOptions).  TInstallOptions are:

Option	Installs:
CmdLineTools	The InterBase command line tools
ConnectivityClients	The InterBase connectivity clients
Examples	The InterBase examples
MainComponents	The main InterBase components
Note: You must install InterBase 6 to use this feature.


TIBInstall.SourceDirectory

TIBInstall	See also

Sets or returns the path of the InterBase installation source files.

property SourceDirectory: String;

Use SourceDirectory to set or return the path of the installation source files.  In most cases, this will be a path on the InterBase CDROM.

Note: You must install InterBase 6 to use this feature.


TIBInstall.SuggestedDestination

TIBInstall	See also

Returns the suggested installation target destination.

property SuggestedDestination: String;

Use SuggestedDestination to return suggested installation target destination.

Note: You must install InterBase 6 to use this feature.


TIBInstall.UnInstallFile

TIBInstall	See also

Returns the name and path of the uninstall file.

property UnInstallFile: String;

Use UnInstallFile to return the binary log file name and path of the uninstall file.  The uninstall file contains information on which options were installed.  This information lets the TIBUnInstall component know what needs to be removed.

Note: You must install InterBase 6 to use this feature.


TIBInstall events

TIBInstall	Alphabetically	Legend

Derived from TIBSetup

OnError

OnStatusChange

OnWarning


TIBInstall events

TIBInstall	By object	Legend

OnError

OnStatusChange

OnWarning


TIBInstall methods

TIBInstall	Alphabetically	Legend

In TIBInstall

Create

Destroy

GetOptionDescription

GetOptionName

GetOptionSpaceRequired

InstallCheck

InstallExecute

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertTComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBInstall methods

TIBInstall	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetOptionDescription

GetOptionName

GetOptionSpaceRequired

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstallCheck

InstallExecute

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction


TIBInstall.Create

TIBInstall	See also

Creates an installation component.

constructor Create(AOwner: TComponent);

Description

Call Create to create an installation component.

Note: You must install InterBase 6 to use this feature.


TIBInstall.Destroy

TIBInstall	See also

Destroys the instance of TIBInstall.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the install object has not already been freed before it calls Destroy.

Note: You must install InterBase 6 to use this feature.


TIBInstall.GetOptionDescription

TIBInstall	See also

Returns a description of the specified option.

type

TCmdOption = (cmDBMgmt, cmDBQuery, cmUsrMgmt);

TConnectivityOption = (cnODBC, cnOLEDB, cnJDBC);

TExamplesOption = (exDB, exAPI);

TMainOption = (moServer, moClient, moConServer, moGuiTools, moDocumentation, moDevelopment);

function GetOptionDescription (Option: TCmdOption): String;

function GetOptionDescription (Option: TConnectivityOption): String;

function GetOptionDescription (Option: TExamplesOption): String;

function GetOptionDescription (Option: TMainOption): String;

Description

Call GetOptionDescription to return a description of the indicated option.  If the specified option is not valid, an error is returned.

Note: You must install InterBase 6 to use this feature.


TIBInstall.GetOptionName

TIBInstall	See also

Returns the option name.

type

TCmdOption = (cmDBMgmt, cmDBQuery, cmUsrMgmt);

TConnectivityOption = (cnODBC, cnOLEDB, cnJDBC);

TExamplesOption = (exDB, exAPI);

TMainOption = (moServer, moClient, moConServer, moGuiTools, moDocumentation, moDevelopment);

function GetOptionName (Option: TCmdOption): String;

function GetOptionName (Option: TConnectivityOption): String;

function GetOptionName (Option: TExamplesOption): String;

function GetOptionName (Option: TMainOption): String;

Description

Call GetOptionName to return the name of the indicated option.

Note: You must install InterBase 6 to use this feature.


TIBInstall.GetOptionSpaceRequired

TIBInstall	See also

Returns the space required to install the indicated option.

type

TCmdOption = (cmDBMgmt, cmDBQuery, cmUsrMgmt);

TConnectivityOption = (cnODBC, cnOLEDB, cnJDBC);

TExamplesOption = (exDB, exAPI);

TMainOption = (moServer, moClient, moConServer, moGuiTools, moDocumentation, moDevelopment);

function GetOptionSpaceRequired (Option: TCmdOption): Longword;

function GetOptionSpaceRequired (Option: TConnectivityOption): Longword;

function GetOptionSpaceRequired (Option: TExamplesOption): Longword;

function GetOptionSpaceRequired (Option: TMainOption): Longword;

Description

Call GetOptionSpaceRequired to return the space required in kilobytes for the indicated option.

Note: You must install InterBase 6 to use this feature.


TIBInstall.InstallCheck

TIBInstall	See also

Checks if the installation is ready to be performed.

procedure InstallCheck;

Description

Call InstallCheck to check if everything is ready for the installation to be performed.

Note: You must install InterBase 6 to use this feature.


TIBInstall.InstallExecute

TIBInstall	See also

Executes the installation.

procedure InstallExecute;

Description

Call InstallExecute to execute the installation.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBSetup

TIBInstall


TInstallOptions

Hierarchy	Properties	Methods	See also

Use TInstallOptions to configure the TIBInstall.Options property.

Unit

IBInstall

Description

Use TInstallOptions to set up the TIBInstall.Options property.

Note: You must install InterBase 6 to use this feature.


TInstallOptions properties

TInstallOptions	Alphabetically	Legend

In TInstallOptions

CmdLineTools

ConnectivityClients

Examples

MainComponents


TInstallOptions properties

TInstallOptions	By object	Legend

CmdLineTools

ConnectivityClients

Examples

MainComponents


TInstallOptions.CmdLineTools

TInstallOptions	See also

Installs the command line tools for InterBase.

type TCmdOption = (cmDBMgmt, cmDBQuery, cmUsrMgmt);

TCmdOptions = set of TCmdOption;

property CmdLineTools: TCmdOptions;

Use CmdLineTools to install the command line tools for InterBase.  The command line tools can be any of the following:

Option	Installs:
DBMgmt	gbak and gfix database management tools; issues a warning if the Client property is not set to True
DBQuery	isql, gdef, and qli database query tools; issues a warning if the Client property is not set to True
UsrMgmt	gsec user management tool issues a warning if the Client property is not set to True
Note: You must install InterBase 6 to use this feature.


TInstallOptions.ConnectivityClients

TInstallOptions	See also

Installs the connectivity clients for InterBase.

type TConnectivityOption = (cnODBC, cnOLEDB, cnJDBC);

TConnectivityOptions = set of TConnectivityOption;

property ConnectivityClients: TConnectivityOptions;

Use ConnectivityClients to install the InterBase connectivity clients.  The clients can be any of the following:

Option	Installs:
cnODBC	The Open Database Connectivity client
cnOLEDB	The OLE DB connectivity client
cnJDBC	The InterClient Java connectivity client
Note: You must install InterBase 6 to use this feature.


TInstallOptions.Examples

TInstallOptions	See also

Installs all the InterBase examples.

type TExamplesOption = (exDB, exAPI);

TExamplesOptions = set of TExamplesOption;

property Examples: TExamplesOptions;

Use Examples to install the following types of InterBase examples:

Option	Installs:
exAPI	API, SQL, DSQL, and ESQL example files; issues a warning if the Client and Development properties are not set to True
exDev	Database examples; issues a warning if the Server property is not set to True
Note: You must install InterBase 6 to use this feature.


TInstallOptions.MainComponents

TInstallOptions	See also

Installs the InterBase main components.

type TMainOption = (moServer, moClient, moConServer, moGuiTools, moDocumentation, moDevelopment);

TMainOptions = set of TMainOption;

property MainComponents: TMainOptions;

Use MainComponents to install the InterBase main components, including the client, server, development tools, documentation, and ODBC driver and driver manager.  TMainOptions are:

Option	Installs:
moClient	Client component, including the client library, license file, and message file
moConServer	Connectivity server, for future implementation.
moDevelopment	Development tools, including gpre, the import libraries, and the header files
moDocumentation	Documentation, including PDF files and indexes
moGuiTools	Graphical interface tools, including IBConsole
moServer	Server component, including: the server, license file (if present), message file, the Guardian, server configuration tool, the database information tools, UDF library, International character set library, and help files (Windows only)
Note: You must install InterBase 6 to use this feature.


TInstallOptions methods

TInstallOptions	Alphabetically	Legend

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TInstallOptions methods

TInstallOptions	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


Hierarchy

TObject

TPersistent

TInstallOptions


 TIBLicensingService

Hierarchy	Properties	Methods	Events	See also

TIBLicensingService configures the licensing parameters

Unit

IBServices

Description

Use a TIBLicensingService component to add or remove InterBase software activation certificates.

Note: You must install InterBase 6 to use this feature.


TIBLicensingService properties

TIBLicensingService	Alphabetically	Legend

In TIBLicensingService

Action

ID

Key

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBLicensingService properties

TIBLicensingService	By object	Legend

Action

Active

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Handle

ID

IsServiceRunning

Key

LoginPrompt

Name

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject


TIBLicensingService.Action

TIBLicensingService	See also	Example

Sets or returns the licensing action.

type TLicensingAction = (LicenseAdd, LicenseRemove);

property Action: TLicensingAction;

Use Action to set or return the licensing action.  The licensing action can be either:

LicenseAdd	Calls the AddLicense procedure (the default)
LicenseRemove	Calls the RemoveLicense procedure
Note: You must install InterBase 6 to use this feature.


TIBLicensingService.ID

TIBLicensingService	See also 	Example

Sets or returns the license identification.

property ID: String;

Use ID to set or return the license identification.

Note: You must install InterBase 6 to use this feature.


TIBLicensingService.Key

TIBLicensingService	See also 	Example

Sets or returns the license key.

property Key: String;

Use Key to set or return the license key.

Note: You must install InterBase 6 to use this feature.


TIBLicensingService events

TIBLicensingService	Alphabetically	Legend

Derived from TIBCustomService

OnAttach

OnLogin


TIBLicensingService events

TIBLicensingService	By object	Legend

OnAttach

OnLogin


TIBLicensingService methods

TIBLicensingService	Alphabetically	Legend

In TIBLicensingService

AddLicense

RemoveLicense

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Create

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBLicensingService methods

TIBLicensingService	By object	Legend

AddLicense

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveLicense

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


TIBLicensingService.AddLicense

TIBLicensingService	See also 	Example

Adds an InterBase software activation certificate.

procedure AddLicense;

Description

Call AddLicense along to add an InterBase software activation certificate.  The Key and ID properties must be supplied.

Note: You must install InterBase 6 to use this feature.


TIBLicensingService.RemoveLicense

TIBLicensingService	See also 	Example

Removes an InterBase software activation certificate.

procedure RemoveLicense;

Description

Call RemoveLicense to remove an InterBase software activation certificate.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBLicensingService


 TIBLogService

Hierarchy	Properties	Methods	Events	See also 	Example

TIBLogService returns the contents of the interbase.log file from a server.

Unit

IBServices

Description

Use a TIBLogService object to return the contents of the interbase.log file from a server.

Note: You must install InterBase 6 to use this feature.


TIBLogService properties

TIBLogService	Alphabetically	Legend

Derived from TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBLogService properties

TIBLogService	By object	Legend

Active

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Eof

Handle

IsServiceRunning

LoginPrompt

Name

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject


TIBLogService events

TIBLogService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBLogService events

TIBLogService	By object	Legend

OnAttach

OnLogin


TIBLogService methods

TIBLogService	Alphabetically	Legend

Derived from TIBControlAndQueryService

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Create

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBLogService methods

TIBLogService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService

TIBLogService


TIBMasterDataLink

Hierarchy	Properties	Methods	Events	See also

TIBMasterDataLink allows a dataset to establish a master/detail relationship.

Unit

IBTable

Description

Use TMasterDataLink as a private member of a dataset object that can represent the detail records for another dataset. TIBMasterDataLink maintains a list of field components from the master dataset, and passes on data events to the data source that owns it. In the constructor of the dataset that uses TIBMasterDataLink to link to another data source, create the TIBMasterDataLink object and set any event handlers to respond to data events.

Do not confuse the dataset that is the value of the DataSet property of TIBMasterDataLink with the dataset that uses TIBMasterDataLink to link to a master dataset. The DataSet property is the master dataset, while the dataset that owns the TIBMasterDataLink object is the detail set.

TIBTable objects already include a TIBMasterDataLink object.


TIBMasterDataLink properties

TIBMasterDataLink	Alphabetically	Legend

In TIBMasterDataLink

FieldNames

Fields

Derived from TDetailDataLink

DetailDataSet

Derived from TDataLink

Active

ActiveRecord

BOF

BufferCount

DataSet

DataSource

DataSourceFixed

Editing

Eof

ReadOnly

RecordCount


TIBMasterDataLink properties

TIBMasterDataLink	By object	Legend

Active

ActiveRecord

BOF

BufferCount

DataSet

DataSource

DataSourceFixed

DetailDataSet

Editing

Eof

FieldNames

Fields

ReadOnly

RecordCount

FieldNames

Fields


TIBMasterDataLink.FieldNames

TIBMasterDataLink	See also

Contains the names of fields from the data source that are represented by the dataset that owns the TIBMasterDataLink object.

property FieldNames: String;

Description

Set FieldNames to the fields that the dataset which owns the TIBMasterDataLink object should represent. Each field name in the string must be separated from other field names with a semicolon.

Setting FieldNames causes TIBMasterDataLink to regenerate the Fields property from the field components of the source dataset. Once the Fields property has been regenerated, TIBMasterDatalink triggers an OnMasterChange event.


TIBMasterDataLink.Fields

TIBMasterDataLink	See also

Lists all the field components from the data source that are used by the dataset that owns the TIBMasterDataLink.

property Fields: TList;

Description

Use Fields to access individual field components from the source data set. Fields provides the values for the Fields property of the dataset that owns the TIBMasterDataLink.

Fields is a read-only property. Fields is generated by locating the field components referenced by the FieldNames property in the source dataset.


TIBMasterDataLink events

TIBMasterDataLink	Alphabetically	Legend

In TIBMasterDataLink

OnMasterChange

OnMasterDisable


TIBMasterDataLink events

TIBMasterDataLink	By object	Legend

OnMasterChange

OnMasterDisable


TIBMasterDataLink.OnMasterChange

TIBMasterDataLink	See also

Occurs when a master data link changes.

property OnMasterChange: TNotifyEvent;

Description

Write an OnMasterChange event handler to take specific actions when a master data link changes.


TIBMasterDataLink.OnMasterDisable

TIBMasterDataLink	See also

Occurs when a master data link is disabled.

property OnMasterDisable: TNotifyEvent;

Description

Write an OnMasterDisable event handler to take specific actions when a master data link is disabled.


TIBMasterDataLink methods

TIBMasterDataLink	Alphabetically	Legend

In TIBMasterDataLink

Create

Destroy

Derived from TDataLink

Edit

ExecuteAction

UpdateAction

UpdateRecord

Derived from TPersistent

Assign

GetNamePath

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBMasterDataLink methods

TIBMasterDataLink	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

Edit

ExecuteAction

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException

UpdateAction

UpdateRecord


TIBMasterDataLink.Create

TIBMasterDataLink	See also

Creates an instance of a TIBMasterDataLink.

constructor Create(DataSet: TDataSet);

Description

Call Create from the constructor of the dataset that uses TIBMasterDataLink to link to a secondary data source. The dataset that uses the TIBMasterDataLink passes itself as the DataSet parameter.

Create associates the instance of TIBMasterDataLink with the dataset that owns it, and creates the helper objects it uses to manage the list of field components.


TIBMasterDataLink.Destroy

TIBMasterDataLink	See also

Destroys the instance of TIBMasterDataLink.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call the Free method from the destructor of the dataset that owns the TIBMasterDataLink object. Free verifies that the TIBMasterDataLink object is not already freed, and only then calls Destroy.

Destroy frees up the memory used to manage the list of field components.


Hierarchy

TObject

TPersistent

TDataLink

TDetailDataLink

TIBMasterDataLink


 TIBOutputDelimitedFile

Hierarchy	Properties	Methods	See also

TIBOutputDelimitedFile performs batch output of data to delimited files.

Unit

Description

Use a TIBOutputDelimitedFile object to perform batch output of data to delimited files.


TIBOutputDelimitedFile properties

TIBOutputDelimitedFile	Alphabetically	Legend

In TIBOutputDelimitedFile

ColDelimiter

OutputTitles

RowDelimiter

Derived from TIBBatch

Columns

FileName

Params


TIBOutputDelimitedFile properties

TIBOutputDelimitedFile	By object	Legend

ColDelimiter

Columns

FileName

OutputTitles

Params

RowDelimiter


TIBOutputDelimitedFile.ColDelimiter

TIBOutputDelimitedFile	See also

Sets the column delimiter for the output file.

property ColDelimiter: String;

Description

Use ColDelimiter to set the column delimiter (either Tab-Ctrl-F or |~) for the output file.


TIBOutputDelimitedFile.OutputTitles

TIBOutputDelimitedFile	See also

Outputs the titles at the top of the file.

property OutputTitles: Boolean;

Description

Set OutputTitles to True to output the titles at the top of the file.


TIBOutputDelimitedFile.RowDelimiter

TIBOutputDelimitedFile	See also

Sets the row delimiter for the output file.

property RowDelimiter: String;

Description

Use RowDelimiter to set the column delimiter (either Tab-Ctrl-F or |~) for the output file.


TIBOutputDelimitedFile methods

TIBBatchOutput	Alphabetically	Legend

In TIBOutputDelimitedFile

Destroy

ReadyFile

WriteColumns

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBOutputDelimitedFile methods

TIBBatch	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadyFile

SafeCallException

WriteColumns


TIBOutputDelimitedFile.Destroy

TIBOutputDelimitedFile	See also

Destroys the instance of TIBOutputDelimitedFile.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TIBOutputDelimitedFile object is not already freed and only then calls Destroy.


TIBOutputDelimitedFile.ReadyFile

TIBOutputDelimitedFile	See also

Prepares the output for the XSQLDA.

procedure ReadyFile;

Description

Call Ready file to prepare the output for the extended SQL descriptor area (XSQLDA).


TIBOutputDelimitedFile.WriteColumns

TIBOutputDelimitedFile	See also

Outputs the data in columns in the XSQLDA.

function WriteColumns: Boolean;

Description

Set WriteColumns to True to output data in columns in the extended SQL descriptor area (XSQLDA).


Hierarchy

TObject

TIBBatch

TIBBatchOutput

TIBOutputDelimitedFile


 TIBOutputRawFile

Hierarchy	Properties	Methods	See also	Example

TIBOutputRawFile outputs data to a raw file format.

Unit

Description

Use a TIBOutputRawFile object to output data from a raw file.  A raw file is the equivalent to InterBase external file output.  Raw files are not limited to a straight character format.


TIBOutputRawFile properties

TIBOutputRawFile	Alphabetically	Legend

Derived from TIBBatch

Columns

FileName

Params


TIBOutputRawFile properties

TIBOutputRawFile	By object	Legend

Columns

FileName

Params


TIBOutputRawFile methods

TIBBatchOuput	Alphabetically	Legend

In TIBOutputRawFile

Destroy

ReadyFile

WriteColumns

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBOutputRawFile methods

TIBBatch	By object	Legend

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

ReadyFile

SafeCallException

WriteColumns


TIBOutputRawFile.Destroy

TIBOutputRawFile	See also

Destroys the instance of TIBOutputRawFile.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TIBOutputRawFile object is not already freed and only then calls Destroy.


TIBOutputRawFile.ReadyFile

TIBOutputRawFile	See also

Prepares the output for the XSQLDA.

procedure ReadyFile;

Description

Call Ready file to prepare the output for the extended SQL descriptor area (XSQLDA).


TIBOutputRawFile.WriteColumns

TIBOutputRawFile	See also

Outputs the data in columns in the XSQLDA.

function WriteColumns: Boolean;

Description

Call WriteColumns to output data in columns in the extended SQL descriptor area (XSQLDA).


Hierarchy

TObject

TIBBatch

TIBBatchOutput

TIBOutputRawFile


 TIBQuery

Hierarchy	Properties	Methods	Events	See also

TIBQuery executes an InterBase SQL statement.

Unit

IBQuery

Description

Use TIBQuery to access one or more tables in a database using SQL statements. The TIBQuery component provides a read-only dataset, and adapts well to the InterBase client/server environment. To update the result set that TIBQuery represents, use this component in conjunction with a TIBUpdateSQL component.

Query components are useful because they can

Access more than one table at a time (called a “join” in SQL).

Automatically access a subset of rows and columns in its underlying table(s), rather than always returning all rows and columns.

Note:	TIBQuery is of particular importance to the development of scaleable database applications. If there is any chance that an application built to run against local databases will be scaled to a remote SQL database server in the future, use TIBQuery components from the start to ensure easier scaling later.


TIBQuery properties

TIBQuery	Alphabetically	Legend

In TIBQuery

Filtered

GenerateParamNames

ParamCount

Params

Prepared

RowsAffected

SQL

StmtHandle

Text

Derived from TIBCustomDataSet

BufferChunks

CachedUpdates

CanModify

Database

DataSource

DBHandle

ForcedRefresh

GeneratorField

LiveMode

ParamCheck

Plan

RecNo

RecordCount

RecordSize

StatementType

Transaction

TRHandle

Unidirectional

UpdateObject

UpdateRecordTypes

UpdatesPending

Derived fromTDataSet

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

Constraints

DataSetField

DefaultFields

Designer

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

FilterOptions

Found

IsUniDirectional

Modified

Name

ObjectView

SparseArrays

State

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TIBQuery properties

TIBQuery	By object	Legend

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

BufferChunks

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constraints

Database

DataSetField

DataSource

DBHandle

DefaultFields

Designer

DesignInfo

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

Filtered

FilterOptions

ForcedRefresh

Found

GenerateParamNames

GeneratorField

IsUniDirectional

LiveMode

Modified

Name

ObjectView

Owner

ParamCheck

ParamCount

Params

Plan

Prepared

RecNo

RecordCount

RecordSize

RowsAffected

SparseArrays

SQL

State

StatementType

StmtHandle

Tag

Text

Transaction

TRHandle

Unidirectional

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TIBQuery.Filtered

TIBQuery 	See also

Specifies whether filtering is active for a dataset.

property Filtered: Boolean;

Description

Check Filtered to determine whether dataset filtering is in effect. If Filtered is True, then filtering is active. Otherwise Filtered is False. To apply filter conditions specified in the Filter property or the OnFilterRecord event handler, set Filtered to True.  Filtered is set to False by default.

Note:	When filtering is enabled, user edits to a record may mean that the record no longer meets a filter’s test condition. The next time the record is retrieved from the dataset while the filter is in effect, the record may seem to disappear. If that happens, the next record that passes the filter condition becomes the current record.


TIBQuery.GenerateParamNames

TIBQuery 	See also

Generates a list of parameter names for the query.

property GenerateParamNames: Boolean;

Description

Set GenerateParamNames to True to have the query generate a list of parameter names.


TIBQuery.ParamCount

TIBQuery	See also	Example

Indicates the current number of parameters for the query.

property ParamCount: Word;

Description

Inspect ParamCount to determine how many parameters are in the Params property. If the ParamCheck property is True, ParamCount always corresponds to the number of actual parameters in the SQL statement for the query.


TIBQuery.Params

TIBQuery	See also	Example

Contains the parameters for a query’s SQL statement.

property Params: TParams;

Description

Access Params at runtime to view and set parameter names, values, and data types dynamically (at design time use the collection editor for the Params property to set parameter information). Params is a zero-based array of TParams parameter records. Index specifies the array element to access.

Note:	An easier way to set and retrieve parameter values when the name of each parameter is known is to call ParamByName. ParamByName cannot, however, be used to change a parameter’s data type or name.


TIBQuery.Prepared

TIBQuery	See also	Example

Determines whether or not a query is prepared for execution.

property Prepared: Boolean;

Description

Examine Prepared to determine if a query is already prepared for execution. If Prepared is True, the query is prepared, and if Prepared is False, the query is not prepared. While a query need not be prepared before execution, execution performance is enhanced if the query is prepared beforehand, particularly if it is a parameterized query that is executed more than once using the same parameter values.

Note:	An application can change the current setting of Prepared to prepare or unprepare a query. If Prepared is True, setting it to False calls the Unprepare method to unprepare the query. If Prepared is False, setting it to True calls the Prepare method to prepare the query. Generally, however, it is better programming practice to call Prepare and Unprepare directly. These methods automatically update the Prepared property.


TIBQuery.RowsAffected

TIBQuery	See also

Returns the number of rows operated upon by the latest query execution.

property RowsAffected: Integer;

Description

Check RowsAffected to determine how many rows were updated or deleted by the last query operation. If RowsAffected is -1, the query did not update or delete any rows.


TIBQuery.SQL

TIBQuery	See also	Example

Contains the text of the SQL statement to execute for the query.

property SQL: TStrings;

Description

Use SQL to provide the SQL statement that a query component executes when its ExecSQL or Open method is called. At design time the SQL property can be edited by invoking the String List editor in the Object Inspector.

The SQL property may contain only one complete SQL statement at a time.


TIBQuery.StmtHandle

TIBQuery

Identifies the statement handle for the query.

property StmtHandle: TISC_STMT_HANDLE;

Description

Retrieve StmtHandle if an application makes a direct call to the InterBase server, bypassing the methods of TIBQuery. Some API calls require a statement handle as a parameter. Under all other circumstances an application does not need to access this property.


TIBQuery.Text

TIBQuery	See also

Points to the actual text of the SQL query.

property Text: string;

Description

Text is a read-only property that can be examined to determine the actual contents of SQL statement. For parameterized queries, Text contains the SQL statement with parameters replaced by the parameter substitution symbol (?) in place of actual parameter values.

In general there should be no need to examine the Text property. To access or change the SQL statement for the query, use the SQL property. To examine or modify parameters, use the Params property.


TIBQuery events

TIBQuery	Alphabetically	Legend

Derived from TIBCustomDataSet

AfterDatabaseDisconnect

AfterTransactionEnd

BeforeDatabaseDisconnect

BeforeTransactionEnd

DatabaseFree

OnUpdateError

OnUpdateRecord

TransactionFree

Derived from TDataSet

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TIBQuery events

TIBQuery	By object	Legend

AfterCancel

AfterClose

AfterDatabaseDisconnect

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

AfterTransactionEnd

BeforeCancel

BeforeClose

BeforeDatabaseDisconnect

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

BeforeTransactionEnd

DatabaseFree

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnUpdateError

OnUpdateRecord

TransactionFree


TIBQuery methods

TIBQuery	Alphabetically	Legend

In TIBQuery

BatchInput

BatchOutput

Create

Destroy

ExecSQL

GetDetailLinkFields

ParamByName

Prepare

UnPrepare

Derived from TIBCustomDataSet

ApplyUpdates

BookmarkValid

CachedUpdateStatus

CancelUpdates

CompareBookmarks

CreateBlobStream

Current

FetchAll

GetCurrentRecord

GetFieldData

IsSequenced

Locate

LocateNext

Lookup

Post

RecordModified

RevertRecord

SQLType

Undelete

UpdateStatus

Derived from TDataSet

ActiveBuffer

Append

AppendRecord

Cancel

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBlobFieldData

GetBookmark

GetDetailDataSets

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBQuery methods

TIBQuery	By object	Legend

ActiveBuffer

AfterConstruction

Append

AppendRecord

ApplyUpdates

Assign

BatchInput

BatchOutput

BeforeDestruction

BookmarkValid

CachedUpdateStatus

Cancel

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CompareBookmarks

ControlsDisabled

Create

CreateBlobStream

Current

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableControls

Dispatch

Edit

EnableControls

ExecSQL

ExecuteAction

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBlobFieldData

GetBookmark

GetCurrentRecord

GetDetailDataSets

GetDetailLinkFields

GetFieldData

GetFieldList

GetFieldNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsImplementorOf

IsLinkedTo

IsSequenced

Last

Locate

LocateNext

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

ParamByName

Post

Prepare

Prior

RecordModified

ReferenceInterface

Refresh

RemoveComponent

RemoveFreeNotification

SetSubComponent

Resync

RevertRecord

SafeCallException

SetFields

SetSubComponent

SQLType

Translate

Undelete

UnPrepare

UpdateAction

UpdateCursorPos

UpdateRecord

UpdateStatus


TIBQuery.BatchInput

TIBQuery	See also

Executes the parameterized query in SQL for input in the referenced input object.

procedure BatchInput(InputObject: TIBBatchInput);

Description

Call BatchInput to execute the parameterized query in SQL for input in the referenced input object.


TIBQuery.BatchOutput

TIBQuery	See also

Outputs the selected query in SQL to the referenced OutputObject.

procedure BatchOutput(OutputObject: TIBBatchOutput);

Description

Call BatchOutput to output the selected query in SQL to the referenced OutputObject.


TIBQuery.Create

TIBQuery	See also

Creates an instance of a query component.

constructor Create(AOwner: TComponent);

Description

Call Create to instantiate a query at runtime. Query components placed in forms or data modules at design time are created automatically.

Create calls its inherited Create constructor, creates an empty SQL statement list, creates an empty parameter list, sets the OnChange event handler for the SQL statement list, sets the ParamCheck property to True, and sets the RowsAffected property to -1.


TIBQuery.Destroy

TIBQuery	See also

Destroys the instance of a query.

destructor Destroy;

Description

Do not call Destroy directly. Instead call Free to verify that the query is not already freed before calling Destroy. Destroy disconnects from the server, frees the SQL statement list and the parameter list, and then calls its inherited destructor.


TIBQuery.ExecSQL

TIBQuery	See also 	Example

Executes the SQL statement for the query.

procedure ExecSQL;

Description

Call ExecSQL to execute the SQL statement currently assigned to the SQL property. Use ExecSQL to execute queries that do not return a cursor to data (such as INSERT, UPDATE, DELETE, and CREATE TABLE).

Note:	For SELECT statements, call Open instead of ExecSQL.

ExecSQL prepares the statement in SQL property for execution if it has not already been prepared. To speed performance, an application should ordinarily call Prepare before calling ExecSQL for the first time.


TIBQuery.GetDetailLinkFields

TIBCustomDataSet	See also

Fills lists with the master and detail fields of the link.

procedure GetDetailLinkFields(MasterFields, DetailFields: TList);

Description

Creates two lists of TFields from the master-detail relationship between two tables; one containing the master fields, and the other containing the detail fields.


TIBQuery.ParamByName

TIBQuery	See also	Example

Accesses parameter information based on a specified parameter name.

function ParamByName(const Value: string): TParam;

Description

Call ParamByName to set or use parameter information for a specific parameter based on its name.

Value is the name of the parameter for which to retrieve information.

ParamByName is primarily used to set an parameter’s value at runtime. For example, the following statement retrieves the current value of a parameter called “Contact” into an edit box:

Edit1.Text := Query1.ParamByName('Contact').AsString;


TIBQuery.Prepare

TIBQuery	See also	Example

Sends a query to the server for optimization prior to execution.

procedure Prepare;

Description

Call Prepare to have the remote database server allocate resources for the query and to perform additional optimizations. Calling Prepare before executing a query improves application performance.

Delphi automatically prepares a query if it is executed without first being prepared. After execution, Delphi unprepares the query. When a query will be executed a number of times, an application should always explicitly prepare the query to avoid multiple and unnecessary prepares and unprepares.

Preparing a query consumes some database resources, so it is good practice for an application to unprepare a query once it is done using it. The UnPrepare method unprepares a query.

Note:	When you change the text of a query at runtime, the query is automatically closed and unprepared.


TIBQuery.UnPrepare

TIBQuery	See also

Frees the resources allocated for a previously prepared query.

procedure UnPrepare;

Description

Call UnPrepare to free the resources allocated for a previously prepared query on the server and client sides.

Preparing a query consumes some database resources, so it is good practice for an application to unprepare a query once it is done using it. The UnPrepare method unprepares a query.

Note:	When you change the text of a query at runtime, the query is automatically closed and unprepared.


Hierarchy

TObject

TPersistent

TComponent

TDataSet

TIBCustomDataSet

TIBQuery


 TIBRestoreService

Hierarchy	Properties	Methods	Events	See also

TIBRestoreService allows you to restore your database.

Unit

IBServices

Description

Use a TIBRestoreService object to restore your database.

Note: You must install InterBase 6 to use this feature.


TIBRestoreService properties

TIBRestoreService	Alphabetically	Legend

In TIBRestoreService

BackupFile

DatabaseName

Options

PageBuffers

PageSize

Derived from TIBBackupRestoreService

Verbose

Derived from TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBRestoreService properties

TIBRestoreService	By object	Legend

Active

BackupFile

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DatabaseName

DesignInfo

Eof

Handle

IsServiceRunning

LoginPrompt

Name

Options

Owner

PageBuffers

PageSize

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject

Verbose


TIBRestoreService.BackupFile

TIBRestoreService	See also 	Example

Sets or returns the backup file name.

property BackupFile: [Index: Integer] String;

Use BackupFile to set or return the backup file name.

Note: You must install InterBase 6 to use this feature.


TIBRestoreService.DatabaseName

TIBRestoreService 	Example

Sets or returns the database name.

property DatabaseName: TStrings;

Use DatabaseName to set or return the database name.

Note: You must install InterBase 6 to use this feature.


TIBRestoreService.Options

TIBRestoreService	See also	Example

Sets the options for the database restore.

type TRestoreOption = (DeactivateIndexes, NoShadow, NoValidityCheck, OneRelationAtATime, Replace, CreateNew, UseAllSpace);

  TRestoreOptions = set of TRestoreOption;

property Options: TRestoreOptions;

Use Options to select the options for the database backup.  TRestoreOptions are:

DeactivateIndexes	Normally, InterBase rebuilds indexes when it restores a database. If the database contained duplicate entries in a unique index when it was backed up, restoration fails. Duplicate values can be introduced into a database if indexes were temporarily made inactive (for example, to allow insertion of many records or to rebalance an index). To enable restoration to succeed in this case, set DeactivateIndexes to True. This makes indexes inactive and prevents them from rebuilding.
NoShadow	Normally, InterBase rebuilds previously defined database shadows when it restores a database. To make sure the shadows are not built, set the NoShadow option to True.
NoValidityCheck	If you redefine validity constraints in a database where data is already entered, your data might no longer satisfy the validity constraints. You might not discover this until you try to restore the database, at which time an error about invalid data appears. To restore a database that contains invalid data, set NoValidity to True. This deletes validity constraints from the metadata. After the database is restored, change the data to make it valid according to the new integrity constraints. Then add back the constraints that were deleted. Important: Always make a copy of metadata before redefining it; for example with the MetadataOnly option of the Options property of TIBBackupService.
OneRelationAtATime	Set OneRelationATime to True to restore the metadata and data for each table together, one table at a time. This option is useful when you are having trouble restoring a backup file; for example, if the data is corrupt or invalid according to integrity constraints.
Replace	Your application cannot overwrite an existing database file unless you set Replace to True. If you attempt to restore to an existing database name and this option is not set, then the restore will not proceed. Important:  Do not restore an existing database file when clients are operating on it. A safer approach is to rename the existing database file, restore the database, then drop or archive the old database as needed.
CreateNew	To restore a database to a new file, set the Create option to True.
UseAllSpace	When InterBase restores a database, it fills each data page to 80% of capacity by default. To set your application to restore a database with a 100% fill ratio on each data page, set the UseAllSpace option to True.
Note: You must install InterBase 6 to use this feature.


TIBRestoreService.PageBuffers

TIBRestoreService	See also 	Example

Sets or returns page buffer size.

property PageBuffers: Integer;

Use PageBuffers to set or return the page buffer size in kilobytes.

Note: You must install InterBase 6 to use this feature.


TIBRestoreService.PageSize

TIBRestoreService	See also 	Example

Sets or returns the page size.

property PageSize: Integer;

Use PageSize to set or return the page size in kilobytes.

Note: You must install InterBase 6 to use this feature.


TIBRestoreService events

TIBRestoreService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBRestoreService events

TIBRestoreService	By object	Legend

OnAttach

OnLogin


TIBRestoreService methods

TIBRestoreService	Alphabetically	Legend

In TIBRestoreService

Create

Destroy

Derived from TIBControlAndQueryService

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName


TIBRestoreService methods

TIBRestoreService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


TIBRestoreService.Create

TIBRestoreService	See also

Creates an instance of TIBRestoreService

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBRestoreService.

Note: You must install InterBase 6 to use this feature.


TIBRestoreService.Destroy

TIBRestoreService	See also

Destroys the service.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the service object has not already been freed before it calls Destroy.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService

TIBBackupRestoreService

TIBRestoreService


 TIBSecurityService

Hierarchy	Properties	Methods	Events	See also

TIBSecurityService enables you to manage user access to the InterBase server.

Unit

IBServices

Description

Use a TIBSecurityService object to manage user access to the InterBase server.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService properties

TIBSecurityService	Alphabetically	Legend

In TIBSecurityService

FirstName

GroupID

LastName

MiddleName

Password

SecurityAction

SQLRole

UserID

UserInfo

UserInfoCount

UserName

Derived from TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBSecurityService properties

TIBSecurityService	By object	Legend

Active

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Eof

FirstName

GroupID

Handle

IsServiceRunning

LastName

LoginPrompt

MiddleName

Name

Owner

Params

Password

Protocol

ServerName

ServiceParamBySPB

Tag

SecurityAction

SQLRole

UserID

UserInfo

UserInfoCount

UserName

VCLComObject


TIBSecurityService.FirstName

TIBSecurityService	See also 	Example

Sets or returns the user’s first name.

property FirstName: String;

Use FirstName to set or return the user’s first name.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.GroupID

TIBSecurityService	See also 	Example

Sets or returns the user’s group ID number.

property GroupID: Integer;

Use GroupID to set or return the user’s group identification number (GID).

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.LastName

TIBSecurityService	See also 	Example

Sets or returns the user’s last name.

property LastName: String;

Use LastName to set or return the user’s last name.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.MiddleName

TIBSecurityService	See also 	Example

Sets or returns the user’s middle name.

property MiddleName: String;

Use MiddleName to set or return user’s middle name.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.Password

TIBSecurityService	See also 	Example

Sets the user’s password.

property Password: String;

Use Password to indicate the user’s password when adding or modifying a user’s information.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.SecurityAction

TIBSecurityService	See also

Sets or returns the security action.

type TSecurityAction = (ActionAddUser, ActionDeleteUser, ActionModifyUser, ActionDisplayUser);

property SecurityAction: TSecurityAction;

Use SecurityAction to set or return the security action.  TSecurityAction can be one of the following:

ActionAddUser	Add the user
ActionDeleteUser	Delete the user
ActionDisplayUser	Display the user’s information
ActionModifyUser	Modify the user account
Note: You must install InterBase 6 to use this feature.


TIBSecurityService.SQLRole

TIBSecurityService	See also

The role name used to connect to the isc4.gdb security database.

property SQLRole: String;

Use SQLRole to set or return role name used to connect to the isc4.gdb security database.  For more information about using SQL roles with InterBase, refer to "ANSI SQL 3 roles" in the InterBase 6 Operations Guide

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.UserID

TIBSecurityService	See also 	Example

Sets or returns the user’s ID number.

property UserID: Integer;

Use UserID to set or return the user’s identification number (UID).

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.UserInfo

TIBSecurityService	See also 	Example

Returns user information.

type

TUserInfo = record

    UserName: string;

    FirstName: string;

    MiddleName: string;

    LastName: string;

    GroupID: Integer;

    UserID: Integer;

end;

property UserInfo [Index: Integer]: TUserInfo;

Use UserInfo to return the user’s information as a TUserInfo record, which contains the user name, groupID, userID, and the user’s first, middle, and last names.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.UserInfoCount

TIBSecurityService	See also 	Example

Returns the number of elements in the TUserInfo array.

property UserInfoCount: Integer;

Use UserInfoCount to return the number of elements in the TUserInfo array.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.UserName

TIBSecurityService	See also 	Example

Sets or returns the user’s login name.

property UserName: String;

Use UserName to set or return the user’s login (user) name.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService events

TIBSecurityService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBSecurityService events

TIBSecurityService	By object	Legend

OnAttach

OnLogin


TIBSecurityService methods

TIBSecurityService	Alphabetically	Legend

In TIBSecurityService

AddUser

Create

DeleteUser

Destroy

DisplayUser

DisplayUsers

ModifyUser

Derived from TIBControlAndQueryService

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBSecurityService methods

TIBSecurityService	By object	Legend

AddUser

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

DeleteUser

Destroy

DestroyComponents

Destroying

Detach

Dispatch

DisplayUser

DisplayUsers

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

ModifyUser

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


TIBSecurityService.AddUser

TIBSecurityService	See also 	Example

Adds a user to the user table.

procedure AddUser;

Description

Call AddUser to add a user to the user table.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.Create

TIBSecurityService	See also

Creates an instance of TIBSecurityService.

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBSecurityService.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.DeleteUser

TIBSecurityService	See also 	Example

Deletes a user from the user table.

procedure DeleteUser;

Description

Call DeleteUser to delete a user from the user table.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.Destroy

TIBSecurityService	See also

Destroys the service.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the service object has not already been freed before it calls Destroy.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.DisplayUser

TIBSecurityService	See also 	Example

Fetches user information.

procedure DisplayUser (UserName: String);

Description

Call DisplayUser to fetch user information and dump it into the TUserInfo record, which can then be returned by the UserInfo property.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.DisplayUsers

TIBSecurityService	See also 	Example

Fetches information for all users.

procedure DisplayUsers;

Description

Call DisplayUsers to fetch all valid user information, which can then be returned by the UserInfo property.

Note: You must install InterBase 6 to use this feature.


TIBSecurityService.ModifyUser

TIBSecurityService	See also

Modifies user information.

procedure ModifyUser;

Description

Call ModifyUser to modify a user’s information.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService

TIBSecurityService


TIBSetup

Hierarchy	Properties	Methods	Events	See also

TIBSetup is the ancestor object from which TIBInstall and TIBUnInstall are derived.

Unit

IBInstall

Description

TIBSetup is the ancestor object from which TIBInstall and TIBUnInstall are derived.

Note: You must install InterBase 6 to use this feature.


TIBSetup properties

TIBSetup	Alphabetically	Legend

In TIBSetup

ErrorContext

MsgFilePath

Progress

RebootToComplete

StatusContext

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBSetup properties

TIBSetup	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

ErrorContext

MsgFilePath

Name

Owner

Progress

RebootToComplete

StatusContext

Tag

VCLComObject


TIBSetup.ErrorContext

TIBSetup	See also

Sets or returns the error context.

property ErrorContext: Pointer;

Use ErrorContext to set or return the user-defined data for the error function.

Note: You must install InterBase 6 to use this feature.


TIBSetup.MsgFilePath

TIBSetup	See also

Sets or returns the installation message file path.

property MsgFilePath: string;

Use MsgFilePath to set or return the full directory path to the filename.msg file.  Most of the time this is the same as the source and path where the InterBase product is installed.

This property allows you to supply your own installation messages.  It is also possible to write the setup program in such a way that you could switch languages on demand, by providing several filename.msg files at different locations.

The filename.msg file normally contains:

•	Error messages

•	Option names and descriptions

•	Actions descriptions and status messages that are logged to the ibinstall.log file

Note: You must install InterBase 6 to use this feature.


TIBSetup.Progress

TIBSetup	See also

Returns the installation progress.

property Progress: Integer;

Use Progress to return the installation progress as an integer between 0 and 100.  Progress is updated by the OnStatusChange event.

Note: You must install InterBase 6 to use this feature.


TIBSetup.RebootToComplete

TIBSetup	See also

Sets whether it is necessary to reboot to complete the installation.

property RebootToComplete: Boolean;

Use RebootToComplete to set whether it is necessary to reboot the system to complete the installation or uninstallation.  By default, this is not necessary (False).

Note: You must install InterBase 6 to use this feature.


TIBSetup.StatusContext

TIBSetup	See also

Sets or returns the status context.

property StatusContext: Pointer;

Use StatusContext to set or return the user-defined data for the status function.

Note: You must install InterBase 6 to use this feature.


TIBSetup events

TIBSetup	Alphabetically	Legend

In TIBSetup

OnError

OnStatusChange

OnWarning


TIBSetup events

TIBSetup	By object	Legend

OnError

OnStatusChange

OnWarning


TIBSetup.OnError

TIBSetup	See also

Occurs when an installation error occurs.

type TIBSetupOnError = function (Sender : TObject; IscCode : MSG_NO; ErrorMessage : String) : integer of object;

property OnError: TIBSetupOnError;

Description

Write an OnError event handler to take specific actions when an error occurs during installation.

The event handler is expected to return isc_fp_install_continue, isc_install_abort or isc_fp_install_retry, and may also use ErrorComment.

Note: You must install InterBase 6 to use this feature.


TIBSetup.OnStatusChange

TIBSetup	See also

Occurs when a change in installation status occurs.

type TIBSetupOnStatus = function(Sender : TObject): integer of object;

property OnStatusChange: TIBSetupOnStatus;

Description

Write an OnStatusChange event handler to take specific actions when a status change occurs during installation.

Status events are generated from time to time when InstallExecute is called. The event informs the user of the installation progress. The event handler might want to use the StatusComment property to display information about the current installation status. The progress is returned by the Progress property as an integer  from 1-100.

Note: You must install InterBase 6 to use this feature.


TIBSetup.OnWarning

TIBSetup	See also

Occurs when an installation warning occurs.

type TIBSetupOnWarning = function(Sender :TObject; WarningCode: MSG_NO; WarningMessage : String): Integer of object;

property OnWarning: TIBSetupOnWarning;

Description

Write an OnWarning event handler to take specific actions when a warning occurs.

An OnWarning event is generated whenever warning is reported, and must return either isc_fp_install_continue or isc_install_abort.  The event handler may also use ErrorComment.

Note: You must install InterBase 6 to use this feature.


TIBSetup methods

TIBSetup	Alphabetically	Legend

In TIBSetup

Create

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBSetup methods

TIBSetup	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction


TIBSetup.Create

TIBInstall	See also

Creates an installation component.

constructor Create(AOwner: TComponent);

Description

Call Create to create an installation component.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBSetup


TIBSQL

Hierarchy	Properties	Methods	Events	See also

TIBSQL provides an object for executing an InterBase SQL statement with minimal overhead.

Unit

IBSQL

Description

Use a TIBSQL object to execute an InterBase SQL statement with minimal overhead.  TIBSQL has no standard interface to data-aware controls and is unidirectional.


TIBSQL properties

TIBSQL	Alphabetically	Legend

In TIBSQL

Bof

Database

DBHandle

Eof

FieldIndex

Fields

GenerateParamNames

GoToFirstRecordOnExecute

Handle

Open

ParamCheck

Params

Plan

Prepared

RecordCount

RowsAffected

SQL

SQLType

Transaction

TRHandle

UniqueRelationName

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBSQL properties

TIBSQL	By object	Legend

Bof

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DBHandle

DesignInfo

Eof

FieldIndex

Fields

GenerateParamNames

GoToFirstRecordOnExecute

Handle

Name

Open

Owner

ParamCheck

Params

Plan

Prepared

RecordCount

RowsAffected

SQL

SQLType

Tag

Transaction

TRHandle

UniqueRelationName

VCLComObject


TIBSQL.Bof

TIBSQL	See also

Indicates whether or not a query is at the beginning of the dataset.

property Bof: Boolean;

Use the BOF property to determine whether or not a query is at the beginning of the dataset.


TIBSQL.Database

TIBSQL	See also

Sets or returns the database associated with the query.

property Database: TIBDatabase;

Description

Use the Database property to set or return the database associated with the query.


TIBSQL.DBHandle

TIBSQL	See also

Specifies the database handle for the query.

property DBHandle: PISC_DB_HANDLE;

Description

Use the DBHandle property to return the database handle for the query.


TIBSQL.Eof

TIBSQL	See also

Indicates whether or not a query is at the end of the dataset.

property Eof: Boolean;

Description

Use the EOF property to determine whether or not a query is at the end of the dataset and whether or not the query returned any result rows.

In addition, if this property is True immediately after the query is opened, then it means that the dataset is empty.


TIBSQL.FieldIndex

TIBSQL	See also

Returns the index of the named field.

property FieldIndex: [FieldName: String]: Integer;

Description

Use the FieldIndex property to return the index of the name field.


TIBSQL.Fields

TIBSQL	See also

Returns the XSQLVAR fields.

property Fields[const Idx: Integer]: TIBXSQLVAR;

Description

Use the Fields property to return the XSQLVAR fields.


TIBSQL.GenerateParamNames

TIBSQL 	See also

Generates a list of parameter names for the query.

property GenerateParamNames: Boolean;

Description

Set GenerateParamNames to True to have the query generate a list of parameter names.


TIBSQL.GoToFirstRecordOnExecute

TIBSQL	See also

Goes to the first record in the result set upon opening it.

property GoToFirstRecordOnExecute: Boolean;

Description

Use the GoToFirstRecordOnExecute property to go to the first record in a result set upon opening it.  By default, this property is set to True.  GoToFirstRecordOnExecute exists primarily for use in TIBDataSet, which sets this value to False for its internal TIBSQLs.


TIBSQL.Handle

TIBSQL	See also

Specifies the handle for the query.

property Handle: TISC_STMT_HANDLE;

Description

Use the Handle property to get the query handle.


TIBSQL.Open

TIBSQL	See also

Determines if the dataset is open.

property Open: Boolean;

Description

Use the Open property to determine if the dataset is open.


TIBSQL.ParamCheck

TIBSQL	See also

Specifies whether the parameter list for an SQL query is regenerated if the SQL property changes at runtime.

property ParamCheck: Boolean;

Description

This property is useful for data definition language (DDL) statements that contain parameters as part of the DDL statement and that are not parameters for the TIBSQL query. For example, the DDL statement to create a stored procedure may contain parameter statements that are part of the stored procedure. Set ParamCheck to False to prevent these parameters from being mistaken for parameters of the TIBSQL query executing the DDL statement.

An application that does not use parameterized queries may choose to set ParamCheck to False, but otherwise ParamCheck should be True.


TIBSQL.Params

TIBSQL	See also

Returns the XSQLDA parameters.

property Params: TIBXSQLDA;

Description

Use the Params property to return the XSQLDA parameters.


TIBSQL.Plan

TIBSQL	See also

Returns the plan for the query.

property Plan: String;

Description

Use the Plan property to view the query plan once the query has been prepared.


TIBSQL.Prepared

TIBSQL	See also 	Example

Indicates whether or not the query has been prepared.

property Prepared: Boolean;

Description

Use the Prepared property to determine whether or not a query has yet been prepared.


TIBSQL.RecordCount

TIBSQL	See also

Returns the current count of records from the query.

property RecordCount: Integer;

Description

Use the RecordCount property to see how many records are returned by a query.  If the result set is to return 100 rows, RecordCount will only be 100 after all the records have been visited.  That is, after looking at the first record, RecordCount is 1, and so forth.


TIBSQL.RowsAffected

TIBSQL	See also

Returns the number of rows affected.

property RowsAffected: Integer;

Description

Use the RowsAffected property to return the number of rows affected by the query.  This property is useful for INSERT, DELETE, and UPDATE statements.


TIBSQL.SQL

TIBSQL	See also

Sets the SQL query to be executed.

property SQL: TStrings;

Description

Use the SQL property to write or view the SQL query to be executed.


TIBSQL.SQLType

TIBSQL	See also

Returns the type of query to be executed.

type TIBSQLTypes = set of (SQLUnknown, SQLSelect, SQLInsert, SQLUpdate, SQLDelete, SQLDDL, SQLGetSegment, SQLPutSegment, SQLExecProcedure, SQLStartTransaction, SQLCommit, SQLRollback, SQLSelectForUpdate, SQLSetGenerator);

property SQLType: TIBSQLTypes read FSQLType;

Description

Use the SQLType to determine the type of query to be executed.  Query types include:

SQLCommit	Commits an active transaction
SQLDDL	Modifies the database metadata
SQLDelete	Removes rows in a table or in the active set of a cursor
SQLExecProcedure	Calls a stored procedure
SQLGetSegment	Reads a segment from an open Blob
SQLInsert	Adds one or more new rows to a specified table
SQLPutSegment	Writes a Blob segment
SQLRollback	Restores the database to its state prior to the start of the current transaction
SQLSelectForUpdate	Used for positioned updates.
SQLSetGenerator	Sets a new value for an existing generator
SQLSelect	Retrieves data from one or more tables
SQLStartTransaction	Starts a new transaction against one or more databases
SQLUnknown	Unknown SQL type
SQLUpdate	Changes data in all or part of an existing row in a table, view, or active set of a cursor


TIBSQL.Transaction

TIBSQL	See also

Sets or returns the transaction to be used by the query.

property Transaction: TIBTransaction;

Description

Use the Transaction property to set or return the transaction to be used by the query.


TIBSQL.TRHandle

TIBSQL	See also

Specifies the transaction handle for the query.

property TRHandle: PISC_TR_HANDLE;

Description

Use the TRHandle property to return the transaction handle for the query.


TIBSQL.UniqueRelationName

TIBSQL	See also

Indicates the unique relation name.

property UniqueRelationName: String;

Description

Use the UniqueRelationName property to indicate the unique relation name for a query that involves only one base table.


TIBDynSQL events

TIBSQL	Alphabetically	Legend

In TIBSQL

OnSQLChanging


TIBDynSQL events

TIBSQL	By object	Legend

OnSQLChanging


TIBSQL.OnSQLChanging

TIBSQL	See also

Occurs when the SQL query is being modified.

property OnSQLChanging: TNotifyEvent;

Description

Write an OnSQLChanging event handler to take specific actions when a query is being modified.  If an exception is raised in this event, the query is not changed.


TIBSQL methods

TIBSQL	Alphabetically	Legend

In TIBSQL

BatchInput

BatchOutput

Call

CheckClosed

CheckOpen

CheckValidStatement

Close

Create

Current

Destroy

ExecQuery

FieldByName

FreeHandle

GetUniqueRelationName

Next

ParamByName

Prepare

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBSQL methods

TIBSQL	By object	Legend

AfterConstruction

Assign

BatchInput

BatchOutput

BeforeDestruction

Call

CheckClosed

CheckOpen

CheckValidStatement

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Close

Create

Current

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecQuery

ExecuteAction

FieldAddress

FieldByName

FindComponent

Free

FreeHandle

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetUniqueRelationName

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

Next

ParamByName

Prepare

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction


TIBSQL.BatchInput

TIBSQL	See also	Example

Executes the parameterized query in SQL for input in the referenced input object.

procedure BatchInput(InputObject: TIBBatchInput);

Description

Call BatchInput to execute the parameterized query in SQL for input in the referenced input object.


TIBSQL.BatchOutput

TIBSQL	See also 	Example

Outputs the selected query in SQL to the referenced OutputObject.

procedure BatchOutput(OutputObject: TIBBatchOutput);

Description

Call BatchOutput to output the selected query in SQL to the referenced OutputObject.


TIBSQL.Call

TIBSQL	See also

Returns an error message based on the error code.

function Call(ErrCode: ISC_STATUS; RaiseError: Boolean): ISC_STATUS;

Description

Call is an internal method used to make calls to the InterBase API, and gives you the option of raising an exception or returning an error based on the value of RaiseError.


TIBSQL.CheckClosed

TIBSQL	See also

Raises an exception if the query is not closed.

procedure CheckClosed;

Description

Call CheckClosed to raise an exception if the query is not closed.


TIBSQL.CheckOpen

TIBSQL	See also

Raises an exception if the query is not open.

procedure CheckOpen;

Description

Call CheckOpen to raise an exception if the query is closed.


TIBSQL.CheckValidStatement

TIBSQL	See also

Raises an exception if the query does not have a valid statement.

procedure CheckValidStatement;

Description

Call CheckValidStatement to raise an exception if the query does not have a valid statement.


TIBSQL.Close

TIBSQL	See also

Closes the query.

procedure Close;

Description

Call Close to close the query.


TIBSQL.Create

TIBSQL	See also

Creates an instance of a TIBSQL component.

constructor Create(AOwner:TComponent);

Description

Call Create to create an instance of a TIBSQL component.


TIBSQL.Current

TIBSQL	See also

Returns an extended SQL descriptor for the current record.

function Current: TIBXSQLDA;

Description

Call Current to get an extended SQL descriptor for the current record.


TIBSQL.Destroy

TIBSQL	See also

Frees all resources associated with this instance.

destructor Destroy;

Description

Do not call Destroy directly in an application. Usually destruction of objects is handled automatically by Delphi. If an application creates its own instance of an update object, however, the application should call Free, which verifies that the update object is not already freed before calling Destroy.


TIBSQL.ExecQuery

TIBSQL	See also

Executes an SQL query.

procedure ExecQuery;

Description

Call ExecQuery to execute the SQL query.


TIBSQL.FieldByName

TIBSQL	See also

Returns the XSQLVAR fields by name.

function FieldByName[FieldName: String]: TIBXSQLVAR;

Description

Use the FieldByName method to return the XSQLVAR fields by name.


TIBSQL.FreeHandle

TIBSQL	See also

Frees InterBase resources associated with the query.

procedure FreeHandle;

Description

Call FreeHandle to free the InterBase resources associated with the query.


TIBSQL.GetUniqueRelationName

TIBSQL	See also

Gets the unique relation name.

function GetUniqueRelationName: String;

Description

Call GetUniqueRelationName to get the unique relation name of the query.


TIBSQL.Next

TIBSQL	See also

Returns an extended SQL descriptor for the next record.

function Next: TIBXSQLDA;

Description

Call Next to get an extended SQL descriptor for the next record.


TIBSQL.ParamByName

TIBSQL	See also

Accesses parameter information based on a specified parameter name.

function ParamByName(Idx: String): TIBXSQLVAR;

Description

Call ParamByName to set or use parameter information for a specific parameter based on its name.

Idx is the name of the parameter for which to retrieve information.


TIBSQL.Prepare

TIBSQL	See also 	Example

Prepares a query for execution.

procedure Prepare;

Description

Call Prepare to prepare a query for execution.


Hierarchy

TObject

TPersistent

TComponent

TIBSQL


 TIBSQLMonitor

Hierarchy	Properties	Methods 	Events	See also

TIBSQLMonitor monitors dynamic SQL passed to the InterBase server.

Unit

IBSQLMonitor

Description

Use TIBSQLMonitor to monitor dynamic SQL taking place in InterBase applications. Enable TraceFlags in each TIBDatabase component in order for the SQL monitor to receive status information from each database connection.


TIBSQLMonitor properties

TIBSQLMonitor	Alphabetically	Legend

Derived from TIBSQLMonitor

Enabled

Handle

TraceFlags

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBSQLMonitor properties

TIBSQLMonitor	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Enabled

Handle

Name

Owner

Tag

TraceFlags

VCLComObject


TIBSQLMonitor.Enabled

TIBSQLMonitor

Description

Not available.


TIBSQLMonitor.Handle

TIBSQLMonitor

Description

Not available.


TIBSQLMonitor.TraceFlags

TIBSQLMonitor

Description

Not available.


TIBSQLMonitor events

TIBSQLMonitor	Alphabetically	Legend

Derived from TIBCustomSQLMonitor

OnSQL


TIBSQLMonitor events

TIBSQLMonitor	By object	Legend

OnSQL


TIBSQLMonitor methods

TIBSQLMonitor	Alphabetically	Legend

Derived from TIBCustomSQLMonitor

Create

Destroy

Release

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBSQLMonitor methods

TIBSQLMonitor	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

Release

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction


Hierarchy

TObject

TPersistent

TComponent

TIBCustomSQLMonitor

TIBSQLMonitor


 TIBServerProperties

Hierarchy	Properties	Methods	Events	See also

TIBServerProperties returns database server information.

Unit

IBServices

Description

TIBServerProperties returns database server information, including configuration parameters, and version and license information.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties properties

TIBServerProperties	Alphabetically	Legend

In TIBServerProperties

ConfigParams

DatabaseInfo

LicenseInfo

LicenseMaskInfo

Options

VersionInfo

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBServerProperties properties

TIBServerProperties	By object	Legend

Active

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConfigParams

DatabaseInfo

DesignInfo

Handle

LicenseInfo

LicenseMaskInfo

LoginPrompt

Name

Options

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject

VersionInfo


TIBServerProperties.ConfigParams

TIBServerProperties	See also	Example

Returns the server configuration parameters.

type

TConfigFileData = record

    LOCKMEM: Integer;

    LOCKSEM: Integer;

    LOCKSIG: Integer;

    EVNTMEM: Integer;

    DBCACHE: Integer;

    PRIORITY: Integer;

    IPCMAP: Integer;

    MEMMIN: Integer;

    MEMMAX: Integer;

    LOCKORDER: Integer;

    ANYLOCKMEM: Integer;

    ANYLOCKSEM: Integer;

    ANYLOCKSIG: Integer;

    ANYEVNTMEM: Integer;

    LOCKHASH: Integer;

    DEADLOCK: Integer;

    LOCKSPIN: Integer;

    CONN_TIMEOUT: Integer;

    DUMMY_INTRVL: Integer;

  end;

  TConfigParams = record

    ConfigFileData: TConfigFileData;

    BaseLocation: string;

    LockFileLocation: string;

    MessageFileLocation: string;

    SecurityDatabaseLocation: string;

  end;

property ConfigParams: TConfigParams;

Description

Use the ConfigParams property to return the server configuration parameters as a TConfigParams record, which includes the configuration file data, base location, lock file location, message file location, and the security database location.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.DatabaseInfo

TIBServerProperties	See also	Example

Returns database information.

type

TDatabaseInfo = record

    NoOfAttachments: Integer;

    NoOfDatabases: Integer;

    DbName: array of string;

  end;

property DatabaseInfo: TDatabaseInfo;

Description

Use the DatabaseInfo property to return database information as a TDatabaseInfo record, which includes the database name, number of attachments, and number of databases.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.LicenseInfo

TIBServerProperties	See also	Example

Returns license information.

type

TLicenseInfo = record

    Key: array of string;

    Id: array of string;

    Desc: array of string;

    LicensedUsers: Integer;

  end;

property LicenseInfo: TLicenseInfo;

Description

Use the LicenseInfo property to return licensing information as a TLicenseInfo record, which includes the key, ID, and number of licensed users.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.LicenseMaskInfo

TIBServerProperties	See also 	Example

Returns license mask information.

type

TLicenseMaskInfo = record

    LicenseMask: Integer;

    CapabilityMask: Integer;

end;

property LicenseMaskInfo: TLicenseMaskInfo;

Description

Use the LicenseMaskInfo property to return licensing information as a TLicenseMaskInfo record, which includes the license mask and capability mask. A license mask is a bitmask representing the software activation certificate options currently enabled on the server. A capability mask is a bitmask representing the capabilities currently enabled on the server.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.Options

TIBServerProperties	See also 	Example

Sets and returns the server properties.

type

TPropertyOption = (Database, License, ConfigParameters, Version);

  TPropertyOptions = set of TPropertyOption;

property Options: TPropertyOptions;

Description

Use the Options property to set and return server properties, including:

Database	The TDatabaseInfo record
License	The TLicenseInfo record
ConfigParameters	The TConfigParams record
Version	The TVersionInfo record
Note: You must install InterBase 6 to use this feature.


TIBServerProperties.VersionInfo

TIBServerProperties	See also 	Example

Returns version information.

type

TVersionInfo = record

    ServerVersion: String;

    ServerImplementation: string;

    ServiceVersion: Integer;

  end;

property VersionInfo: TVersionInfo;

Description

Use the VersionInfo property to return the server configuration parameters as a TVersionInfo record, which includes the service version, and server version and implementation.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties events

TIBServerProperties	Alphabetically	Legend

Derived from TIBCustomService

OnAttach

OnLogin


TIBServerProperties events

TIBServerProperties	By object	Legend

OnAttach

OnLogin


TIBServerProperties methods

TIBServerProperties	Alphabetically	Legend

In TIBServerProperties

Create

Destroy

Fetch

FetchConfigParams

FetchDatabaseInfo

FetchLicenseInfo

FetchLicenseMaskInfo

FetchVersionInfo

Derived from TIBCustomService

Attach

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBServerProperties methods

TIBServerProperties	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

Fetch

FetchConfigParams

FetchDatabaseInfo

FetchLicenseInfo

FetchLicenseMaskInfo

FetchVersionInfo

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

SafeCallException

SetSubComponent

UpdateAction


TIBServerProperties.Create

TIBServerProperties	See also

Creates an instance of TIBServerProperties

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBServerProperties.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.Destroy

TIBServerProperties	See also

Destroys the instance of TIBServerProperties.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the service object has not already been freed before it calls Destroy.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.Fetch

TIBServerProperties	See also

Fetches information from the server.

procedure Fetch;

Description

Call Fetch to get information from the server.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.FetchConfigParams

TIBServerProperties	See also 	Example

Returns the database configuration parameters.

procedure FetchConfigParams;

Description

Call FetchConfigParams to return database configuration parameters.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.FetchDatabaseInfo

TIBServerProperties	See also 	Example

Returns database information.

procedure FetchDatabaseInfo;

Description

Call FetchDatabaseInfo to return database information.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.FetchLicenseInfo

TIBServerProperties	See also 	Example

Returns license information.

procedure FetchLicenseInfo;

Description

Call FetchLicenseInfo to return database license information.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.FetchLicenseMaskInfo

TIBServerProperties	See also 	Example

Returns license mask information.

procedure FetchLicenseMaskInfo;

Description

Call FetchLicenseMaskInfo to return database license mask information.

Note: You must install InterBase 6 to use this feature.


TIBServerProperties.FetchVersionInfo

TIBServerProperties	See also 	Example

Returns the database version information.

procedure FetchVersionInfo;

Description

Call FetchVersionInfo to return the database version information.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBServerProperties


 TIBStatisticalService

Hierarchy	Properties	Methods	Events	See also

TIBStatisticalService allows you to view database statistics.

Unit

IBServices

Description

Use a TIBStatisticalService object to view database statistics.

Note: You must install InterBase 6 to use this feature.


TIBStatisticalService properties

TIBStatisticalService	Alphabetically	Legend

InTIBStatisticalService

DatabaseName

Options

Derived from TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBStatisticalService properties

TIBStatisticalService	By object	Legend

Active

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DatabaseName

DesignInfo

Eof

Handle

IsServiceRunning

LoginPrompt

Name

Options

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

VCLComObject


TIBStatisticalService.DatabaseName

TIBStatisticalService	See also 	Example

Sets or returns the database name.

property DatabaseName: string;

Use DatabaseName to set or return the database name.

Note: You must install InterBase 6 to use this feature.


TIBStatisticalService.Options

TIBStatisticalService	See also 	Example

Sets the statistical options for the database.

type TStatOption = (DataPages, DbLog, HeaderPages, IndexPages, SystemRelations);

  TStatOptions = set of TStatOption;

property Options: TStatOptions;

Use the Options property to request database statistics. These options are incremental; that is, setting DbLog to True also returns HeaderPages statistics, setting IndexPages to True returns also returns DbLog and HeaderPages statistics, and so forth. Set any of the following options of type TStatOption to True to retrieve the appropriate information:

HeaderPages	Stop reporting statistics after reporting the information on the header page
DbLog	Stop reporting statistics after reporting information on the log pages
IndexPages	Request statistics for the user indexes in the database
DataPages	Request statistics for data tables in the database
SystemRelations	Request statistics for system tables and indexes in addition to user tables and indexes
Note: You must install InterBase 6 to use this feature.


TIBStatisticalService events

TIBStatisticalService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBStatisticalService events

TIBStatisticalService	By object	Legend

OnAttach

OnLogin


TIBStatisticalService methods

TIBStatisticalService	Alphabetically	Legend

Derived from TIBControlAndQueryService

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Create

Destroy

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBStatisticalService methods

TIBStatisticalService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService

TIBStatisticalService


 TIBStoredProc

Hierarchy	Properties	Methods	Events	See also

TIBStoredProc encapsulates a stored procedure on a database server.

Unit

IBStoredProc

Description

Use a TIBStoredProc object when a client application must use a stored procedure on a database server. A stored procedure is a grouped set of statements, stored as part of a database server’s metadata (just like tables, indexes, and domains), that performs a frequently repeated, database-related task on the server and passes results to the client.

Many stored procedures require a series of input arguments, or parameters, that are used during processing. TIBStoredProc provides a Params property that enables an application to set these parameters before executing the stored procedure.

TIBStoredProc reuses the Params property to hold the results returned by a stored procedure. Params is an array of values. A stored procedure will return a single set of values, or none at all.

Note:	TIBStoredProc components should be used with InterBase Execute stored procedures only. To use InterBase Select procedures, use TIBQuery or TIBDataSet.  Since Execute stored procedures do not return result sets, never use Open or Active on the TIBStoredProc component.  Use ExecProc instead.


TIBStoredProc properties

TIBStoredProc	Alphabetically	Legend

In TIBStoredProc

Filtered

ParamCount

Params

Prepared

StmtHandle

StoredProcedureNames

StoredProcName

Derived from TIBCustomDataSet

CanModify

Database

DataSource

DBHandle

ForcedRefresh

Plan

RecNo

RecordCount

RecordSize

RowsAffected

Transaction

TRHandle

UpdateObject

UpdateRecordTypes

UpdatesPending

Derived fromTDataSet

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

DatasetField

DataSource

DefaultFields

Designer

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

FilterOptions

Found

IsUniDirectional

Modified

Name

ObjectView

SparseArrays

State

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TIBStoredProc properties

TIBStoredProc	By object	Legend

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Database

DatasetField

DataSource

DBHandle

DefaultFields

Designer

DesignInfo

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

Filtered

FilterOptions

Found

IsUniDirectional

Modified

Name

ObjectView

Owner

ParamCount

Params

Plan

Prepared

RecNo

RecordCount

RecordSize

RowsAffected

SparseArrays

State

StmtHandle

StoredProcedureNames

StoredProcName

Tag

Transaction

TRHandle

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TIBStoredProc.Filtered

TIBStoredProc 	See also

Specifies whether filtering is active for a dataset.

property Filtered: Boolean;

Description

Check Filtered to determine whether dataset filtering is in effect. If Filtered is True, then filtering is active. Otherwise Filtered is False. To apply filter conditions specified in the Filter property or the OnFilterRecord event handler, set Filtered to True.  Filtered is set to False by default.

Note:	When filtering is enabled, user edits to a record may mean that the record no longer meets a filter’s test condition. The next time the record is retrieved from the dataset while the filter is in effect, the record may seem to disappear. If that happens, the next record that passes the filter condition becomes the current record.


TIBStoredProc.ParamCount

TIBStoredProc	See also	Example

Indicates the number of parameters for the stored procedure component.

property ParamCount: Word;

Description

Examine ParamCount to determine the number of parameters currently stored in the Params property.


TIBStoredProc.Params

TIBStoredProc	See also	Example

Stores the input and output parameters for a stored procedure.

property Params: TParams;

Description

Access Params at runtime to set input parameter names, values, and data types dynamically (at design time use the Parameters editor to set parameter information). Params is an array of parameter values.

An application can also access Params after executing a stored procedure to retrieve the output parameters returned to the procedure by the server.


TIBStoredProc.Prepared

TIBStoredProc	See also

Determines whether or not a stored procedure is prepared for execution.

property Prepared: Boolean;

Description

Examine Prepared to determine if a stored procedure is already prepared for execution. If Prepared is True, the stored procedure is prepared, and if Prepared is False, the procedure is not prepared. A stored procedure must be prepared before it can be executed.

Note:	Delphi automatically prepares a stored procedure if it is unprepared when the application calls ExecProc. After execution, Delphi automatically unprepares the stored procedure. If a procedure will be executed a number of times, it is more efficient for the application to prepare the stored procedure once, and unprepare it when it is no longer needed.

An application can change the current setting of Prepared to prepare or unprepare a stored procedure. If Prepared is True, setting it to False calls the Unprepare method to unprepare the stored procedure. If Prepared is False, setting it to True calls the Prepare method to prepare the procedure. Generally, however, it is better programming practice to call Prepare and Unprepare directly. These methods automatically update the Prepared property.


TIBStoredProc.StmtHandle

TIBStoredProc

Identifies the statement handle for the stored procedure.

property StmtHandle: TISC_STMT_HANDLE;

Description

Retrieve StmtHandle if an application makes a direct call to the InterBase server, bypassing the methods of TIBStoredProc. Some API calls require a statement handle as a parameter. Under all other circumstances an application does not need to access this property.


TIBStoredProc.StoredProcName

TIBStoredProc	See also

Identifies the name of the stored procedure on the server for which this object is an encapsulation.

property StoredProcName: String;

Description

Set StoredProcName to specify the name of the stored procedure to call on the server. If StoredProcName does not match the name of an existing stored procedure on the server, then when the application attempts to prepare the procedure prior to execution, an exception is raised.


TIBStoredProc.StoredProcedureNames

TIBStoredProc	See also

Returns a list of stored procedures in the database.

property StoredProcedureNames: TStrings;

Description

StoredProcedureNames is an internal property used to list the stored procedures available in the database.


TIBStoredProc events

TIBStoredProc	Alphabetically	Legend

Derived from TIBCustomDataSet

AfterDatabaseDisconnect

AfterTransactionEnd

BeforeDatabaseDisconnect

BeforeTransactionEnd

DatabaseFree

OnUpdateError

OnUpdateRecord

TransactionFree

Derived from TDataSet

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TIBStoredProc events

TIBStoredProc	By object	Legend

AfterCancel

AfterClose

AfterDatabaseDisconnect

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

AfterTransactionEnd

BeforeCancel

BeforeClose

BeforeDatabaseDisconnect

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

BeforeTransactionEnd

DatabaseFree

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnUpdateError

OnUpdateRecord

TransactionFree


TIBStoredProc methods

TIBStoredProc	Alphabetically	Legend

In TIBStoredProc

CopyParams

Create

Destroy

ExecProc

ParamByName

Prepare

UnPrepare

Derived from TIBCustomDataSet

ApplyUpdates

BookmarkValid

CachedUpdateStatus

CancelUpdates

CompareBookmarks

CreateBlobStream

Current

FetchAll

GetCurrentRecord

GetFieldData

IsSequenced

Locate

LocateNext

Lookup

Post

RecordModified

RevertRecord

SQLType

Undelete

UpdateStatus

Derived from TDataSet

ActiveBuffer

Append

AppendRecord

Cancel

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBlobFieldData

GetBookmark

GetDetailDataSets

GetDetailLinkFields

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBStoredProc methods

TIBStoredProc	By object	Legend

ActiveBuffer

AfterConstruction

Append

AppendRecord

ApplyUpdates

Assign

BeforeDestruction

BookmarkValid

CachedUpdateStatus

Cancel

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

ControlsDisabled

CopyParams

Create

CreateBlobStream

Current

CursorPosChanged

DefaultHandler

Delete

Destroy

DestroyComponents

Destroying

DisableControls

Dispatch

Edit

EnableControls

ExecProc

ExecuteAction

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBlobFieldData

GetBookmark

GetCurrentRecord

GetDetailDataSets

GetDetailLinkFields

GetFieldData

GetFieldList

GetFieldNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsImplementorOf

IsLinkedTo

IsSequenced

Last

Locate

LocateNext

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

ParamByName

Post

Prepare

Prior

RecordModified

ReferenceInterface

Refresh

RemoveComponent

RemoveFreeNotification

Resync

RevertRecord

SafeCallException

SetFields

SetSubComponent

SQLType

Translate

Undelete

UnPrepare

UpdateCursorPos

UpdateRecord

UpdateAction

UpdateStatus


TIBStoredProc.CopyParams

TIBStoredProc	See also

Copies a stored procedure’s parameters into another parameter list.

procedure CopyParams(Value: TParams);

Description

Call CopyParams to copy this stored procedure’s parameters into a separate parameter list object. Value is the parameter list into which to assign this stored procedure’s parameters. Value can be the parameter list of another stored procedure. For example:

TIBStoredProc1.CopyParams(TIBStoredProc2.Params);

If the stored procedure is not prepared when an application calls CopyParams, CopyParams calls Prepare before assigning the parameters to the target parameters list, and then calls UnPrepare to return the stored procedure to its previous state.


TIBStoredProc.Create

TIBStoredProc	See also

Creates an instance of a stored procedure component.

constructor Create(AOwner: TComponent);

Description

Call Create to instantiate a stored procedure declared in an application. Create calls its inherited Create constructor, creates an empty parameter list for the newly instantiated stored procedure, and initializes its parameter, server, and record buffers to nil.


TIBStoredProc.Destroy

TIBStoredProc	See also

Destroys the instance of a stored procedure.

destructor Destroy;

Description

Do not call Destroy directly. Instead call Free to verify that the stored procedure is not already freed before calling Destroy. Destroy disconnects from the server, frees the parameter list, and calls its inherited Destroy destructor.


TIBStoredProc.ExecProc

TIBStoredProc	See also 	Example

Executes the stored procedure on the server.

procedure ExecProc;

Description

Call ExecProc to execute a stored procedure on the server. Before calling ExecProc:

1	Provide any input parameters in the Params property. At design time, a developer can provide parameters using the Parameters editor. At runtime an application must access Params directly.

2	Call Prepare to bind the parameters.

If a stored procedure returns output parameters, they are stored in the Params property when ExecProc returns control to the application. An application can access the output parameters by indexing into the Params list, or by using the ParamByName method.


TIBStoredProc.ParamByName

TIBStoredProc	See also	Example

Accesses parameter information based on a specified parameter name.

function ParamByName(const Value: string): TParam;

Description

Call ParamByName to return parameter information for a specific parameter based on its name. Value is the name of the parameter for which to retrieve information. Typically ParamByName is used to set an input parameter’s value at runtime, or to retrieve the value of an output parameter. The following command line assigns the value "Jane Smith" as the value for the parameter named Contact:

StoredProc1.ParamByName('Contact').AsString := 'Jane Smith';


TIBStoredProc.Prepare

TIBStoredProc	See also 	Example

Prepares a stored procedure for execution.

procedure Prepare;

Description

Call Prepare to bind a stored procedure’s parameters before calling ExecProc to execute the procedure. Prepare readies a stored procedure’s parameters and informs the server of the stored procedure’s readiness. These steps allocate system resources and optimize the query for server performance.

Note:	If an application attempts to execute a stored procedure that has not been prepared, Delphi automatically prepares the procedure before executing it, and then unprepares it when execution is complete. If a stored procedure will be executed more than once, it is more efficient for an application to call Prepare explicitly once to avoid repeated and unnecessary preparing and unpreparing of the stored procedure, and then call UnPrepare when the stored procedure is no longer needed.


TIBStoredProc.UnPrepare

TIBStoredProc	See also

Frees the resources allocated for a previously prepared stored procedure.

procedure UnPrepare;

Description

Call UnPrepare to free the resources allocated for a previously prepared stored procedure on the server and client sides.


Hierarchy

TObject

TPersistent

TComponent

TDataSet

TIBCustomDataSet

TIBStoredProc


 TIBStringField

Hierarchy	Properties	Methods 	Events	See also

TIBStringField allows for strings in excess of 8196 bytes of data.

Unit

IBCustomDataSet

Description

A value of a string field is physically stored as a sequence of characters. Common uses for string fields are to store text, such as names and addresses.

TIBStringField introduces properties to translate between string values and other data types, and to manage language driver conversions. As a descendent of TStringField, TIBStringField inherits many properties, methods, and events that are useful for managing the value and properties of a field in a database. TIBStringField allows for strings in excess of 8196 bytes of data.


TIBStringField properties

TIBStringField	Alphabetically	Legend

Derived from TStringField

AsBCD

AsBoolean

AsDateTime

AsFloat

AsInteger

AsSQLTimeStamp

AsString

AsVariant

DataSize

FixedChar

Transliterate

Value

Derived from TField

Alignment

AsCurrency

AsDateTime

AttributeSet

AutoGenerateValue

Calculated

CanModify

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataType

DefaultExpression

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

FullName

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

NewValue

Offset

OldValue

Origin

ParentField

ProviderFlags

ReadOnly

Required

Size

Text

ValidChars

Visible

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBStringField properties

TIBStringField	By object	Legend

Alignment

AsBCD

AsBoolean

AsCurrency

AsDateTime

AsFloat

AsInteger

AsSQLTimeStamp

AsString

AsVariant

AttributeSet

AutoGenerateValue

Calculated

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

ConstraintErrorMessage

CurValue

CustomConstraint

DataSet

DataSize

DataType

DefaultExpression

DesignInfo

DisplayLabel

DisplayName

DisplayText

DisplayWidth

EditMask

EditMaskPtr

FieldKind

FieldName

FieldNo

FixedChar

FullName

HasConstraints

ImportedConstraint

Index

IsIndexField

IsNull

KeyFields

Lookup

LookupCache

LookupDataSet

LookupKeyFields

LookupList

LookupResultField

Name

NewValue

Offset

OldValue

Origin

Owner

ParentField

ProviderFlags

ReadOnly

Required

Size

Tag

Text

Transliterate

ValidChars

Value

VCLComObject

Visible


TIBStringField events

TIBStringField	Alphabetically	Legend

Derived from TField

OnChange

OnGetText

OnSetText

OnValidate


TIBStringField events

TIBStringField	By object	Legend

OnChange

OnGetText

OnSetText

OnValidate


TIBStringField methods

TIBStringField	Alphabetically	Legend

In TIBStringField

CheckTypeSize

Create

GetAsString

GetAsVariant

GetValue

SetAsString

Derived from TField

Assign

AssignValue

Clear

Destroy

FocusControl

GetData

GetParentComponent

HasParent

IsBlob

IsValidChar

RefreshLookupList

SetData

SetFieldType

Validate

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBStringField methods

TIBStringField	By object	Legend

AfterConstruction

Assign

AssignValue

BeforeDestruction

CheckTypeSize

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

FocusControl

Free

FreeInstance

FreeNotification

FreeOnRelease

GetAsString

GetAsVariant

GetData

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GetValue

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsBlob

IsImplementorOf

IsValidChar

MethodAddress

MethodName

NewInstance

ReferenceInterface

RefreshLookupList

RemoveComponent

RemoveFreeNotification

SafeCallException

SetAsString

SetData

SetFieldType

SetSubComponent

UpdateAction

Validate


TIBStringField.CheckTypeSize

TIBStringField	See also

Indicates the type size of the string field.

class procedure CheckTypeSize(Value: Integer);

Description

Call CheckTypeSize to determine the type size of the string field.

All sizes are valid for a TIBString field.


TIBStringField.Create

TIBStringField	See also

Creates an instance of a TIBStringField object.

constructor Create(AOwner: TComponent);

Description

It is seldom necessary to call Create directly, because a string field component is instantiated automatically for all string fields in a dataset.

After calling the inherited constructor, Create sets

DataType to ftString.

Size to 20.

Transliterate to True.

BlanksToNull to True


TIBStringField.GetAsString

TIBStringField	See also

Returns the value of a field as a string.

function GetAsString: string;

Description

Call GetAsString to return the value of a field as a string.


TIBStringField.GetAsVariant

TIBStringField	See also

Returns the value of a field as a variant.

function GetAsVariant: Variant;

Description

Call GetAsVariant return the value of a field as type Variant.


TIBStringField.GetValue

TIBStringField	See also

Returns the value of a field.

function GetValue(var Value: string): Boolean;

Description

Call GetValue to return the value of a field.


TIBStringField.SetAsString

TIBStringField	See also

Sets the value of a field as a string type.

procedure SetAsString(const Value: string);

Description

Call SetAsString to set the value of a field as a string type.


Hierarchy

TObject

TPersistent

TComponent

TField

TStringField

TIBStringField


 TIBTable

Hierarchy	Properties	Methods	Events	See also

TIBTable is a dataset component that encapsulates a database table.

Unit

IBTable

Description

Use TIBTable to access data in a single table or view. TIBTable provides direct access to every record and field in an underlying InterBase database table. A table component can also work with a subset of records within a database table using filters.


TIBTable properties

TIBTable	Alphabetically	Legend

In TIBTable

CanModify

CurrentDBKey

DataSource

DefaultIndex

Exists

Filter

Filtered

FilterOptions

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexName

MasterFields

MasterSource

ReadOnly

StoreDefs

TableName

TableNames

TableTypes

Derived from TIBCustomDataSet

BufferChunks

CachedUpdates

Database

DBHandle

ForcedRefresh

LiveMode

Plan

RecNo

RecordCount

RecordSize

RowsAffected

Transaction

TRHandle

Unidirectional

UpdateObject

UpdateRecordTypes

UpdatesPending

Derived from TDataSet

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

Constraints

DataSetField

DefaultFields

Designer

Eof

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Found

IsUniDirectional

Modified

Name

ObjectView

SparseArrays

State

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Owner

Tag

VCLComObject


TIBTable properties

TIBTable	By object	Legend

Active

AggFields

AutoCalcFields

BlockReadSize

Bof

Bookmark

BufferChunks

CachedUpdates

CanModify

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

Constraints

CurrentDBKey

Database

DataSetField

DataSource

DBHandle

DefaultFields

DefaultIndex

Designer

DesignInfo

Eof

Exists

FieldCount

FieldDefList

FieldDefs

FieldList

Fields

FieldValues

Filter

Filtered

FilterOptions

ForcedRefresh

Found

IndexDefs

IndexFieldCount

IndexFieldNames

IndexFields

IndexName

IsUniDirectional

LiveMode

MasterFields

MasterSource

Modified

Name

ObjectView

Owner

Plan

ReadOnly

RecNo

RecordCount

RecordSize

RowsAffected

SparseArrays

State

StoreDefs

TableName

TableNames

TableTypes

Tag

Transaction

TRHandle

Unidirectional

UpdateObject

UpdateRecordTypes

UpdatesPending

VCLComObject


TIBTable.CanModify

TIBTable 	See also

Indicates whether an application can insert, edit, and delete data in a table.

property CanModify: Boolean;

Description

Check the status of CanModify to determine if an application can modify a dataset in any way. If CanModify is True, the dataset can be modified. If CanModify is False, the table is read-only.

CanModify is set automatically when an application opens a table. If the ReadOnly property of a table component is True, then CanModify is set to False. CanModify can also be false because

Another application currently has exclusive write access to the table.

The table is read-only by database design.

Note:	Even if CanModify is True, it is not a guarantee that a user will be able to insert or update records in a table. Other factors may come in to play, for example, SQL access privileges.


TIBTable.CurrentDBKey

TIBTable

Returns the DBKey for the current row in the table.

property CurrentDBKey: TIBDBKey;

Description

Use CurrentDBKey to return the DBKey for the current row in the table. A DBKey is a unique row identifier for the duration of the current transaction.  This property is primarily for internal use.


TIBTable.DataSource

TIBTable	See also

Represents the data source of another dataset that supplies values to the dataset.

property DataSource: TDataSource;

Description

Use DataSource to get the data source of another dataset.


TIBTable.DefaultIndex

TIBTable	See also

Specifies if the data in the table should be ordered on a default index when opened.

property DefaultIndex: Boolean;

Description

When this property is set to False, an ORDER BY clause is not used when opening a table on the server. When DefaultIndex is True, the data is ordered based on the primary key or a unique index when opening the table. DefaultIndex defaults to True.


TIBTable.Exists

TIBTable	See also	Example

Indicates whether the underlying database table exists.

property Exists: Boolean;

Description

Read Exists at runtime to determine whether a database table exists. If the table does not exist, you can create a table from the field definitions and index definitions using the CreateTable method. This property is read-only.


TIBTable.Filter

TIBTable	See also

Specifies rows in a dataset that meet the filter conditions.

property Filter: string;

Description

Use the Filter property to restrict the rows in the dataset to those that meet the filter conditions.  The syntax for Filter is the same as the search condition that appears after a WHERE clause in a Select statement.  For example, to view only those records where the value in the Country field contains 'France' or 'Fiji':

Country = 'France' or Country = 'Fiji'

You can use standard SQL wildcards such as percent (%) and underscore (_) in the condition when you use the LIKE operator.  The following filter condition retrieves all Countries beginning with 'F':

Country LIKE 'F%'

To view rows that have a NULL value in the Country column and Contact_Name is not NULL, use the IS operator:

Country is NULL and Contact_Name is not NULL

You can also use complex expressions in filter clauses.  The following example retrieves rows containing Country values that use Francs as currency.

Country IN (SELECT Country from Country where Currency = '_Franc')


TIBTable.Filtered

TIBTable	See also

Specifies whether or not filtering is active for a table.

property Filtered: Boolean;

Description

Check Filtered to determine whether or not dataset filtering is in effect. If Filtered is True, then filtering is active. To apply filter conditions specified in the Filter property or the OnFilterRecord event handler, set Filtered to True.


TIBTable.FilterOptions

TIBTable	See also

Specifies whether filter strings are applied case-sensitively, and whether partial comparisons are permitted when applying the filter string.

property FilterOptions: TFilterOptions;

Description

Set FilterOptions to indicate how the Filter property is applied. FilterOptions determines whether the Filter property is applied case-sensitively when filtering on string or character fields, and whether partial comparisons for matching filter conditions is allowed.

By default, FilterOptions is set to an empty set. For filters based on string fields, set FilterOptions to foCaseInsensitive to catch all variations on a string regardless of capitalization.

To disable partial string matches in the filter expression, include foNoPartialCompare in the filter options.

Note:	To filter strings bases on partial comparisons, use an asterisk as a wildcard.


TIBTable.IndexDefs

TIBTable	See also	Example

Contains information about the indexes for a table.

property IndexDefs: TIndexDefs;

Description

IndexDefs is an array of index items, each of which describes an available index for the table. Ordinarily an application accesses or specifies indexes through the IndexFieldNames or IndexFields properties. If IndexDefs is updated or manually edited, the StoreDefs property becomes True.

Note:	The index items in IndexDefs may not always reflect the current indexes available for a table. Before examining IndexDefs, call its Update method to refresh the item list.


TIBTable.IndexFieldCount

TIBTable	See also	Example

Indicates the number of fields that comprise the current key.

property IndexFieldCount: Integer;

Description

Examine IndexFieldCount to determine the number of fields that comprise the current key. For indexes based on a single column, IndexFieldCount returns 1. For multi-column indexes, IndexFieldCount indicates the number of fields upon which the index is based.


TIBTable.IndexFieldNames

TIBTable	See also

Lists the columns to use as an index for a table.

property IndexFieldNames: String;

Description

Use IndexFieldNames as an alternative method of specifying the index to use for a table. In IndexFieldNames specify the name of each column to use as an index for a table. Ordering of column names is significant. Separate names with semicolon.

Note:	The IndexFieldNames and IndexName properties are mutually exclusive. Setting one clears the other.


TIBTable.IndexFields

TIBTable	See also	Example

Retrieves or sets a field for an index.

property IndexFields [Index: Integer]: TField;

Description

IndexFields provides a zero-based array of field objects, each of which corresponds to a field in the current index. Index is an ordinal value indicating the position of a field in the index. The first field in the index is IndexFields[0], the second is IndexFields[1], and so on.

Note:	Do not set IndexField directly. Instead use the IndexFieldNames property to order datasets on the fly at runtime.


TIBTable.IndexName

TIBTable	See also	Example

Identifies an index for the table.

property IndexName: String;

Description

Use IndexName to specify an index for a table. If IndexName is empty, a table’s sort order is based on its primary index.

If IndexName contains a valid index name, then that index is used to determine the order of records.

Note:	IndexFieldNames and IndexName are mutually exclusive. Setting one clears the other.


TIBTable.MasterFields

TIBTable	See also

Specifies one or more fields in a master table to link with corresponding fields in this table in order to establish a master-detail relationship between the tables.

property MasterFields: String;

Description

Use MasterFields after setting the MasterSource property to specify the names of one or more fields to use in establishing a detail-master relationship between this table and the one specified in MasterSource.

MasterFields is a string containing one or more field names in the master table. Separate field names with semicolons.

Each time the current record in the master table changes, the new values in those fields are used to select corresponding records in this table for display.


TIBTable.MasterSource

TIBTable	See also

Specifies the name of the data source for a dataset to use as a master table in establishing a detail-master relationship between this table and another one.

property MasterSource: TDataSource;

Description

Use MasterSource to specify the name of the data source component whose DataSet property identifies a dataset to use as a master table in establishing a detail-master relationship between this table and another one.

After setting the MasterSource property, specify which fields to use in the master table by setting the MasterFields property. At runtime each time the current record in the master table changes, the new values in those fields are used to select corresponding records in this table for display.


TIBTable.ReadOnly

TIBTable	See also

Specifies whether a table is read-only for this application.

property ReadOnly: Boolean;

Description

Use the ReadOnly property to prevent users from updating, inserting, or deleting data in the table. By default, ReadOnly is False, meaning users can potentially alter a table’s data.

Note:	Even if ReadOnly is False, users may not be able to modify or add data to a table. Other factors, such as insufficient SQL privileges for the application or its current user may prevent successful alterations.

To guarantee that users cannot modify or add data to a table,

1	Set the Active property to False.

2	Set ReadOnly to True.


TIBTable.StoreDefs

TIBTable	See also

Indicates whether the table's field and index definitions persist with the data module or form.

property StoreDefs: Boolean;

Description

If StoreDefs is True, the table's index and field definitions are stored with the data module or form. Setting StoreDefs to True makes the CreateTable method into a one-step procedure that creates fields, indexes, and validity checks at runtime.

StoreDefs is False by default. It becomes True whenever FieldDefs or IndexDefs is updated or edited manually; to prevent edited (or imported) definitions from being stored, reset StoreDefs to False.


TIBTable.TableName

TIBTable	See also

Indicates the name of the database table or view that this component encapsulates.

property TableName: String;

Description

Use TableName to specify the name of the database relation this component encapsulates. To set TableName to a meaningful value, the Database property should already be set. If Database is set at design time, then select a valid table name from the TableName drop-down list in the Object Inspector.

Note:	To set TableName, the Active property must be False.


TIBTable.TableNames

TIBTable	See also

Returns a list of table names.

property TableNames: TStrings;

Description

The TableNames property is an internal property used to display a list of the table and view names in the database.


TIBTable.TableTypes

TIBTable	See also

Sets the types of relations displayed in the TableName drop-down list.

type

  TIBTableType = (ttSystem, ttView);

  TIBTableTypes = set of TIBTableType;

property TableTypes: TIBTableTypes;

Description

Use TableTypes to change which types of relations are displayed in the TableName drop-down list, in addition to user tables. TableTypes are:

ttSystem	System tables and views
ttView	User views


TIBTable events

TIBTable	Alphabetically	Legend

Derived from TIBCustomDataSet

AfterDatabaseDisconnect

AfterTransactionEnd

BeforeDatabaseDisconnect

BeforeTransactionEnd

DatabaseFree

OnUpdateError

OnUpdateRecord

TransactionFree

Derived from TDataSet

AfterCancel

AfterClose

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

BeforeCancel

BeforeClose

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError


TIBTable events

TIBTable	By object	Legend

AfterCancel

AfterClose

AfterDatabaseDisconnect

AfterDelete

AfterEdit

AfterInsert

AfterOpen

AfterPost

AfterRefresh

AfterScroll

AfterTransactionEnd

BeforeCancel

BeforeClose

BeforeDatabaseDisconnect

BeforeDelete

BeforeEdit

BeforeInsert

BeforeOpen

BeforePost

BeforeRefresh

BeforeScroll

BeforeTransactionEnd

DatabaseFree

OnCalcFields

OnDeleteError

OnEditError

OnFilterRecord

OnNewRecord

OnPostError

OnUpdateError

OnUpdateRecord

TransactionFree


TIBTable methods

TIBTable	Alphabetically	Legend

In TIBTable

AddIndex

Create

CreateTable

DeleteIndex

DeleteTable

Destroy

EmptyTable

GetDetailLinkFields

GetIndexNames

GotoCurrent

Locate

Derived from TIBCustomDataSet

ApplyUpdates

BookmarkValid

CachedUpdateStatus

CancelUpdates

CompareBookmarks

CreateBlobStream

Current

FetchAll

GetCurrentRecord

GetFieldData

IsSequenced

LocateNext

Lookup

Post

RecordModified

RevertRecord

SQLType

Undelete

UpdateStatus

Derived from TDataSet

ActiveBuffer

Append

AppendRecord

Cancel

CheckBrowseMode

ClearFields

Close

ControlsDisabled

CursorPosChanged

Delete

DisableControls

Edit

EnableControls

FieldByName

FindField

FindFirst

FindLast

FindNext

FindPrior

First

FreeBookmark

GetBlobFieldData

GetBookmark

GetDetailDataSets

GetFieldList

GetFieldNames

GotoBookmark

Insert

InsertRecord

IsEmpty

IsLinkedTo

Last

MoveBy

Next

Open

Prior

Refresh

Resync

SetFields

Translate

UpdateCursorPos

UpdateRecord

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBTable methods

TIBTable	By object	Legend

ActiveBuffer

AddIndex

AfterConstruction

Append

AppendRecord

ApplyUpdates

Assign

BeforeDestruction

BookmarkValid

CachedUpdateStatus

Cancel

CancelUpdates

CheckBrowseMode

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

ClearFields

Close

CompareBookmarks

ControlsDisabled

Create

CreateBlobStream

CreateTable

Current

CursorPosChanged

DefaultHandler

Delete

DeleteIndex

DeleteTable

Destroy

DestroyComponents

Destroying

DisableControls

Dispatch

Edit

EmptyTable

EnableControls

ExecuteAction

FetchAll

FieldAddress

FieldByName

FindComponent

FindField

FindFirst

FindLast

FindNext

FindPrior

First

Free

FreeBookmark

FreeInstance

FreeNotification

FreeOnRelease

GetBlobFieldData

GetBookmark

GetCurrentRecord

GetDetailDataSets

GetDetailLinkFields

GetFieldData

GetFieldList

GetFieldNames

GetIndexNames

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

GotoBookmark

GotoCurrent

HasParent

InheritsFrom

InitInstance

Insert

InsertComponent

InsertRecord

InstanceSize

IsEmpty

IsImplementorOf

IsLinkedTo

IsSequenced

Last

Locate

LocateNext

Lookup

MethodAddress

MethodName

MoveBy

NewInstance

Next

Open

Post

Prior

ReferenceInterface

Refresh

RemoveComponent

RemoveFreeNotification

Resync

RecordModified

RevertRecord

SafeCallException

SetFields

SetSubComponent

SQLType

Translate

Undelete

UpdateAction

UpdateCursorPos

UpdateRecord

UpdateStatus


TIBTable.AddIndex

TIBTable	See also	Example

Creates a new index for the table.

procedure AddIndex(const Name, Fields: string; Options: TIndexOptions const DescFields: string = ' ');

Description

Call AddIndex to create a new index for the table associated with a dataset. The index created with this procedure is added to the database table underlying the dataset. Name is the name of the new index. Fields is a semicolon-delimited list of the fields to include in the index. Options is a potentially restricted set attributes for the index. It can specify that an index

Represents the primary index for a dataset. (ixPrimary)

Contains no duplicate values (ixUnique).

Sorts records in descending order (isDescending).

Warning:	Attempting to create an index using options that are not applicable to the table raises an exception.


TIBTable.Create

TIBTable	See also

Creates an instance of a table component.

constructor Create(AOwner: TComponent);

Description

Call Create to instantiate a table declared in an application if it was not placed on a form at design time. Create calls its inherited Create constructor, creates an empty index definitions list, creates an empty data link, and creates an empty list of index files.


TIBTable.CreateTable

TIBTable	See also	Example

Builds a new table using new structure information.

procedure CreateTable;

Description

Call CreateTable at runtime to create a table using this dataset’s current definition. CreateTable overwrites an existing table’s structure and data; to avoid overwriting an existing table, check Exists before calling CreateTable.

If the FieldDefs property contains values, these values are used to create field definitions. Otherwise the Fields property is used. One or both of these properties must contain values in order to recreate a dataset.

If the IndexDefs property contain values, these values are used to create index definitions for the dataset.


TIBTable.DeleteIndex

TIBTable	See also

Deletes an index for the table.

procedure DeleteIndex(const Name: string);

Description

Call DeleteIndex to remove an index for a table. Name is the name of the index to delete. DeleteIndex cannot remove an index used by a constraint.


TIBTable.DeleteTable

TIBTable	See also

Deletes an existing database table.

procedure DeleteTable;

Description

Call DeleteTable to delete an existing database table associated with the table component through its Database and TableName properties. A table must be closed before it can be deleted.

Warning:	Deleting a table erases any data the table contains and destroys the table’s structure information.


TIBTable.Destroy

TIBTable	See also

Destroys the instance of a table.

destructor Destroy;

Description

Do not call Destroy directly. Instead call Free to verify that the table is not already freed before calling Destroy. Destroy frees the index files list for the table, frees its data link, frees its index definitions, and then calls its inherited Destroy destructor.


TIBTable.EmptyTable

TIBTable	See also

Deletes all records from the table.

procedure EmptyTable;

Description

The EmptyTable method deletes all records from the database table specified by the Database and TableName properties.

Note:	Deletion of records can fail if the user lacks sufficient privileges to perform the delete operation.


TIBTable.GetDetailLinkFields

TIBTable	See also

Lists the field components that link this dataset as a detail of a master dataset.

procedure GetDetailLinkFields(MasterFields, DetailFields: TList);

Description

GetDetailLinkFields fills two lists of TFields that define a master-detail relationship between this table and another (master) dataset. The MasterFields list is filled with fields from the master table whose values must equal the values of the fields in the DetailFields list. The DetailFields list is filled with fields from the calling dataset.


TIBTable.GetIndexNames

TIBTable	See also

Retrieves a list of available indexes for a table.

procedure GetIndexNames(List: TStrings);

Description

Call GetIndexNames to retrieve a list of all available indexes for a table. List is a string list object, created and maintained by the application, into which to retrieve the index names.


TIBTable.GotoCurrent

TIBTable	See also

Synchronizes the current record for this table with the current record of a specified table component.

procedure GotoCurrent(Table: TIBTable);

Description

Call GotoCurrent to synchronize the cursor position for this table based on the cursor position in another dataset that uses a different data source component, but which is connected to the same underlying database table. Table is the name of the table component whose cursor position to use for synchronizing.

Note:	This procedure works only for table components that have the same Database and TableName properties. Otherwise an exception is raised.

GotoCurrent is mainly for use in applications that have two table components that are linked to the same underlying database table through different data source components. It enables an application to ensure that separate views of the data appear to be linked.


TIBTable.Locate

TIBTable	See also

Searches the table for a specified record and makes that record the current record.

function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean;

Description

Call Locate to search a dataset for a specific record and position the cursor on it.

KeyFields is a string containing a semicolon-delimited list of field names on which to search.

KeyValues is a variant that specifies the values to match in the key fields. If KeyFields lists a single field, KeyValues specifies the value for that field on the desired record. To specify multiple search values, pass a variant array as KeyValues, or construct a variant array on the fly using the VarArrayOf routine. For example:

with CustTable do

Locate('Company;Contact;Phone', VarArrayOf(['Sight Diver', 'P', '408-431-1000']), [loPartialKey]);

Options is a set that optionally specifies additional search latitude when searching on string fields. If Options contains the loCaseInsensitive setting, then Locate ignores case when matching fields. If Options contains the loPartialKey setting, then Locate allows partial-string matching on strings in KeyValues. If Options is an empty set, or if KeyFields does not include any string fields, Options is ignored.

Locate returns True if it finds a matching record, and makes that record the current one. Otherwise Locate returns False.

Locate uses the fastest possible method to locate matching records. If the search fields in KeyFields are indexed and the index is compatible with the specified search options, Locate uses the index. Otherwise Locate creates a filter for the search.


Hierarchy

TObject

TPersistent

TComponent

TDataSet

TIBCustomDataSet

TIBTable


 TIBTransaction

Hierarchy	Properties	Methods	Events	See also

TIBTransaction provides discrete transaction control over a one or more database connections in a database application.

Unit

IBDataBase

Description

All TIBCustomDataSet descendants and TIBSQL need to use a transaction along with a database component to gain access to data in a database.

Note:	In applications that connect an InterBaseExpress dataset to a client dataset, every query must be in its own transaction.  You must use one transaction component for each query component.


TIBTransaction properties

TIBTransaction	Alphabetically	Legend

In TIBTransaction

Active

AutoStopAction

DatabaseCount

Databases

DefaultAction

DefaultDatabase

Handle

HandleIsShared

IdleTimer

InTransaction

Params

SQLObjectCount

SQLObjects

TPB

TPBLength

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBTransaction properties

TIBTransaction	By object	Legend

Active

AutoStopAction

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DatabaseCount

Databases

DefaultAction

DefaultDatabase

DesignInfo

Handle

HandleIsShared

IdleTimer

InTransaction

Name

Owner

Params

SQLObjectCount

SQLObjects

Tag

TPB

TPBLength

VCLComObject


TIBTransaction.Active

TIBTransaction	See also

Specifies whether or not a transaction is active.

property Active: Boolean;

Description

Use Active to determine or set a transaction’s active state.


TIBTransaction.AutoStopAction

TIBTransaction	See also

Specifies what action to take when automatically ending transactions.

type TAutoStopAction = (saNone, saRollback, saCommit, saRollbackRetaining, saCommitRetaining);

property AutoStopAction : TAutoStopAction;

Description

Use AutoStopAction to specify how the transaction should end when it is implicitly stopped. Transactions are implicitly stopped when AutoStopAction is not saNone and the last dataset associated with the transaction closes.

The following table lists the possible values:

Value	Meaning

saNone	Transactions are not implicitly stopped.

saRollback	Transactions are rolled back and closed when stopped implicitly.

saCommit	Transactions are committed and closed when stopped implicitly.

saRollbackRetaining	Transactions are not stopped when the last dataset closes, but all updates, insertions, and deletions of data associated with the current transaction are backed out. This option is only supported in InterBase 6.0 and later.

saCommitRetaining	Transactions are not stopped when the last dataset closes, but all updates, insertions, and deletions of data associated with the current transaction are committed.

Note:	This property only works with the closing of TDataSet descendants. If the transaction also includes TIBSQL components, AutoStopAction should be saNone, because the transaction can’t tell whether there are any active TIBSQL components.


TIBTransaction.DatabaseCount

TIBTransaction	See also

Indicates the number of databases that are part of the transaction.

property DatabaseCount: Integer;

Description

Use DatabaseCount to determine the number of databases involved in a transaction.


TIBTransaction.Databases

TIBTransaction	See also

Returns the database at the given integer index.

property Databases[Index: Integer]: TIBDatabase;

Description

Use Databases to return the database at the given integer index.


TIBTransaction.DefaultAction

TIBTransaction	See also

Specifies what action a transaction should take upon timing out.

type TTransactionAction = (taRollback, taCommit, taRollbackRetaining, taCommitRetaining);

property DefaultAction: TTransactionAction;

Description

Use DefaultAction to what action the transaction should take when the IdleTimer limit is met.  The transaction action can be one of the following:

taRollback	Rolls back the transaction
taCommit	Commits the transaction
taRollbackRetaining	Rolls back the transaction, but retains the current transaction context Note: You must install InterBase 6 to use this feature.
taCommitRetaining	Commits the transaction, but retains the current transaction context


TIBTransaction.DefaultDatabase

TIBTransaction	See also

Sets or returns the default database for the transaction.

property DefaultDatabase: TIBDatabase;

Description

Use DefaultDatabase to set or return the default database for the transaction.


TIBTransaction.Handle

TIBTransaction	See also

Returns the transaction handle.

property Handle: TISC_TR_HANDLE;

Description

Use Handle to retrieve a handle to the transaction.  Handle is assigned an initial value when a transaction is started.


TIBTransaction.HandleIsShared

TIBTransaction	See also

Indicates whether or not the handle is shared.

property HandleIsShared: Boolean;

Description

HandleIsShared returns True when the transaction handle is shared by more than one transaction component.


TIBTransaction.IdleTimer

TIBTransaction	See also

Specifies how long the transaction should wait before automatically committing or rolling back.

property IdleTimer: Integer;

Description

Use IdleTimer to indicate how long a transaction should be allowed to remain idle before automatically committing or rolling back the data.  Use DefaultAction to determine which action the transaction should take.


TIBTransaction.InTransaction

TIBTransaction	See also

Indicates whether a database transaction is in progress or not.

property InTransaction: Boolean;

Description

Examine InTransaction at run-time to determine if a database transaction is currently in progress. InTransaction is True if a transaction is in progress, False otherwise.

The value of InTransaction cannot be changed directly. Calling StartTransaction sets InTransaction to True. Calling Commit or Rollback sets InTransaction to False.


TIBTransaction.Params

TIBTransaction	See also

Returns the transaction parameter buffer associated with the transaction component.

property Params: TStrings;

Description

Use Params to examine and set parameters in the transaction parameter buffer.  Refer to the Interbase API Guide for the names of the parameters to provide.


TIBTransaction.SQLObjectCount

TIBTransaction	See also

Returns the number of active datasets associated with the database component.

property SQLObjectCount: Integer;

Description

Use the SQLObjectCount property to return the number currently active InterBase datasets, TIBSQL objects, and Blobs associated with the database component.  As SQL objects are opened and closed, this value changes appropriately.


TIBTransaction.SQLObjects

TIBTransaction	See also

Provides an indexed array of all active datasets for a database component.

property SQLObjects[Index: Integer]: TIBBase;

Description

Use the SQLObjects to access active InterBase datasets, TIBSQL objects, and Blobs associated with the database component.


TIBTransaction.TPB

TIBTransaction	See also

Provides a read-only view of the transaction parameter buffer.

property TPB: PChar;

Description

Use TPB view the transaction parameter buffer.  To write to the transaction parameter buffer, use the Params property.


TIBTransaction.TPBLength

TIBTransaction	See also

Returns the length of the transaction parameter buffer.

property TPBLength: Short;

Description

Use TPBLength to retrieve the length of the transaction parameter buffer


TIBTransaction events

TIBTransaction	Alphabetically	Legend

In TIBTransaction

OnIdleTimer


TIBTransaction events

TIBTransaction	By object	Legend

OnIdleTimer


TIBTransaction.OnIdleTimer

TIBTransaction	See also

Occurs after a transaction has timed out.

property OnIdleTimer: TNotifyEvent;

Description

Write an OnIdleTimer event handler to take specific actions after a transaction is allowed to remain idle for the number of seconds specified by IdleTimer.


TIBTransaction methods

TIBTransaction	Alphabetically	Legend

In TIBTransaction

AddDatabase

Call

CheckAutoStop

CheckDatabasesInList

CheckInTransaction

CheckNotInTransaction

Commit

CommitRetaining

Create

Destroy

FindDatabase

FindDefaultDatabase

RemoveDatabase

RemoveDatabases

Rollback

RollbackRetaining

StartTransaction

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBTransaction methods

TIBTransaction	By object	Legend

AddDatabase

AfterConstruction

Assign

BeforeDestruction

Call

CheckAutoStop

CheckDatabasesInList

CheckInTransaction

CheckNotInTransaction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Commit

CommitRetaining

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

FindDatabase

FindDefaultDatabase

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveDatabase

RemoveDatabases

RemoveFreeNotification

Rollback

RollbackRetaining

SafeCallException

SetSubComponent

StartTransaction

UpdateAction


TIBTransaction.AddDatabase

TIBTransaction	See also

Associates a database to the transaction.

function AddDatabase(db: TIBDatabase): Integer;

Description

Call AddDatabase to associate a database to the transaction.


TIBTransaction.Call

TIBTransaction	See also

Returns an error message based on the error code.

procedure Call(ErrCode: ISC_STATUS; RaiseError: Boolean): ISC_STATUS;

Description

Call is an internal method used to make calls to the InterBase API, and gives you the option of raising an exception or returning an error based on the value of RaiseError.


TIBTransaction.CheckAutoStop

TIBTransaction	See also

Peforms the action that the AutoStopAction property specifies.

procedure CheckAutoStop;

Description

Datasets call CheckAutoStop at times when it is appropriate to implicitly end a transaction. CheckAutoStop then performs the action that the AutoStopAction property specifies.


TIBTransaction.CheckDatabasesInList

TIBTransaction	See also

Checks for databases in the list.

procedure CheckDatabasesInList;

Description

Call CheckDatabasesInList to check if there are any databases in the list.  If there are no databases in the list, an exception is raised.


TIBTransaction.CheckInTransaction

TIBTransaction	See also

Checks whether the transaction is active and whether there are any databases in the transaction’s database list.

procedure CheckInTransaction;

Description

Call CheckInTransaction to determine whether the transaction is active and whether there are any databases in the transaction’s database list.  If either condition is False, an exception is raised.


TIBTransaction.CheckNotInTransaction

TIBTransaction	See also

Checks that the transaction is not active and that there are no databases in the transaction’s database list.

procedure CheckNotInTransaction;

Description

Call CheckInTransaction to determine that the transaction is not active and that there are no databases in the transaction’s database list.  If either condition is False, an exception is raised.


TIBTransaction.Commit

TIBTransaction	See also 	Example

Permanently stores updates, insertions, and deletions of data associated with the current transaction, and ends the current transactions.

procedure Commit;

Description

Call Commit to permanently store to the database server all updates, insertions, and deletions of data associated with the current transaction and then end the transaction. The current transaction is the last transaction started by calling StartTransaction.

Note:	Before calling Commit, an application may check the status of the InTransaction property. If an application calls Commit and there is no current transaction, an exception is raised.


TIBTransaction.CommitRetaining

TIBTransaction	See also

Commits the active transaction and retains the transaction context after a commit.

procedure CommitRetaining;

Description

Call CommitRetaining to permanently store to the database server all updates, insertions, and deletions of data associated with the current transaction and then retain the transaction context. The current transaction is the last transaction started by calling StartTransaction.

Note:	Before calling CommitRetaining, an application may check the status of the InTransaction property. If an application calls CommitRetaining and there is no current transaction, an exception is raised.


TIBTransaction.Create

TIBTransaction	See also

Creates an instance of a transaction component.

constructor Create(AOwner: TComponent);

Description

Call Create to instantiate a transaction component at runtime. An application creates a transaction component in order to control the component’s existence and set its properties and events.

Create instantiates a transaction component and creates an empty string list for the Params property.


TIBTransaction.Destroy

TIBTransaction	See also

Destroys the instance of the transaction component.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, call Free, which verifies that the transaction component is not already freed before calling Destroy.

Destroy disconnects from the database server, if necessary. It then frees the string resources allocated for the Params and SQLObjects properties before calling its inherited destructor.


TIBTransaction.FindDatabase

TIBTransaction	See also

Finds the index of the associated database.

function FindDatabase (db: TIBDatabase): Integer;

Description

Call FindDatabase to find the index of the associated database.


TIBTransaction.FindDefaultDatabase

TIBTransaction	See also

Finds the default database for the transaction.

function FindDefaultDatabase: TIBDatabase;

Description

Call FindDefaultDatabase to find the default database associated with the transaction.


TIBTransaction.RemoveDatabase

TIBTransaction	See also

Disassociates a database from the transaction.

procedure RemoveDatabase(Idx: Integer);

Description

Call RemoveDatabase to disassociate a specified database from the transaction.


TIBTransaction.RemoveDatabases

TIBTransaction	See also

Disassociates all databases from the transaction.

procedure RemoveDatabases;

Description

Call RemoveDatabases to disassociate all databases from the transaction.


TIBTransaction.Rollback

TIBTransaction	See also	Example

Cancels all updates, insertions, and deletions for the current transaction and ends the transaction.

procedure Rollback;

Description

Call Rollback to cancel all updates, insertions, and deletions for the current transaction and to end the transaction. The current transaction is the last transaction started by calling StartTransaction.

Note:	Before calling Rollback, an application may check the status of the InTransaction property. If an application calls Rollback and there is no current transaction, an exception is raised.


TIBTransaction.RollbackRetaining

TIBTransaction	See also

Cancels all updates, insertions, and deletions for the current transaction and retains the transaction context.

procedure RollbackRetaining;

Description

Call RollbackRetaining to roll back to the database server all updates, insertions, and deletions of data associated with the current transaction and then retain the transaction context. The current transaction is the last transaction started by calling StartTransaction.

Note:	Before calling RollbackRetaining, an application may check the status of the InTransaction property. If an application calls RollbackRetaining and there is no current transaction, an exception is raised.

Note: You must install InterBase 6 to use this feature.


TIBTransaction.StartTransaction

TIBTransaction	See also 	Example

Begins a new transaction against the database server.

procedure StartTransaction;

Description

Call StartTransaction to begin a new transaction against the database server. Before calling StartTransaction, an application should check the status of the InTransaction property. If InTransaction is True, indicating that a transaction is already in progress, a subsequent call to StartTransaction without first calling Commit or Rollback to end the current transaction raises an exception.

Updates, insertions, and deletions that take place after a call to StartTransaction are held by the server until an application calls Commit to save the changes or Rollback is to cancel them.


Hierarchy

TObject

TPersistent

TComponent

TIBTransaction


IBTransaction Editor dialog box

The Transaction Editor dialog box allows you to set up transaction parameters. This dialog box gives you four default transaction settings, which you can then customize if you wish. Once you modify the default transaction, the radio button is unset.

For a complete list of all the InterBase transaction parameters, refer to “Working with Transactions” in the InterBase API Guide.

Snapshot

By default, Snapshot is set to concurrency and nowait, which means that the transaction is aware of other transactions, and does not wait for locks to be released, returning an error instead.

Read Committed

By default, Read Committed is set to read_committed, rec_version, and nowait, which means that the transaction reads changes made by concurrent transactions, can read the most recently committed version of a transaction, and does not wait for locks to be released, returning an error instead.

Read-Only Table Stability

By default, Read-Only Table Stability is set to read and consistency, which means that the transaction can read a specified table and locks out other transactions.

Read-Write Table Stability

By default, Read-Write Table Stability is set to write and consistency, which means that the transaction can read and write to a specified table and locks out other transactions.

For a complete list of all the InterBase transaction parameters, refer to “Working with Transactions” in the InterBase API Guide.


IBAlloc procedure

See also

Allocates or de-allocates memory for a given size, and initializes the new memory to zero.

Unit

IB

procedure IBAlloc(var P; OldSize, NewSize: Integer);

Use IBAlloc to allocate or de-allocate memory for a given size, and initialize the new memory to zero.


CheckStatusVector function

See also

Sets or unsets status vector checking.

Unit

IB

function CheckStatusVector(ErrorCodes: array of ISC_STATUS): Boolean;

Set CheckStatusVector to True to enable status vector checking.


IBError procedure

See also

Returns the error message for the specified error code.

Unit

IB

procedure IBError(ErrMess: EIBClientError; const Args: array of const);

Description

Use the IBError procedure to look up the appropriate error message for a specified error code and raise an EIBClientError exception.


IBDataBaseError procedure

See also

Interprets the SQLCode and IBErrorCode status and passes it to the EIBInterBaseError exception.

Unit

IB

procedure IBDataBaseError;

Description

Use the IBDataBaseError procedure to look at the status vector, interpret the SQLCode and IBErrorCode status, construct the status string, and pass it to the EIBInterBaseError exception.


SetIBDataBaseErrorMessages procedure

See also

Enables you to choose the error messages you want to see.

Unit

IB

type

  TIBDataBaseErrorMessage =(ShowSQLCode, ShowIBMessage, ShowSQLMessage);

  TIBDataBaseErrorMessages = set of TIBDataBaseErrorMessage;

procedure SetIBDataBaseErrorMessages(Value: TIBDataBaseErrorMessages);

Description

Use the SetIBDataBaseErrorMessages procedure to choose the error messages that you want to use.  The available options are defined in TIBDataBaseErrorMessages.


GetIBDataBaseErrorMessages function

See also

Returns the current error message setting.

Unit

IB

type

  TIBDataBaseErrorMessage =(ShowSQLCode, ShowIBMessage, ShowSQLMessage);

  TIBDataBaseErrorMessages = set of TIBDataBaseErrorMessage;

function GetIBDataBaseErrorMessages: TIBDataBaseErrorMessages;

Description

Use the GetIBDataBaseErrorMessages function to return the current error message setting.


StatusVector function

See also

Retrieves the thread-specific status vector from thread-local storage.

Unit

IB

function StatusVector: PISC_STATUS;

Description

Use the StatusVector function to retrieve the thread-specific status from the thread-local storage.


StatusVectorArray function

See also

Returns a pointer to the status vector array.

Unit

IB

function StatusVectorArray: PStatusVector;

Description

Use the StatusVectorArray function to return a pointer to the status vector array from the thread-local storage.


StatusVectorAsText function

See also

Gets the status vector and returns it as a formatted string.

Unit

IB

function StatusVectorAsText: string;

Description

Use the StatusVector function to retrieve the status vector and return it as a formatted string.


LoadIBInstallLibrary procedure

See also

Loads IBInstall.DLL into memory.

Unit

procedure LoadIBInstallLibrary;

Description

Use the LoadIBInstallLibrary procedure to load the IBInstall.DLL into memory and resolve the respective entry points into to the respective procedure pointer in the unit.


LoadIBLibrary procedure

See also

Loads GDS32.DLL into memory.

Unit

procedure LoadIBLibrary;

Description

Use the LoadIBLibrary procedure to load the GDS32.DLL into memory and resolve the respective entry points into to the respective procedure pointer in the unit.


FreeIBInstallLibrary procedure

See also

Frees the IBInstall.DLL from memory.

Unit

procedure FreeIBInstallLibrary;

Description

Use the FreeIBInstallLibrary procedure to free the previously loaded the IBInstall.DLL from memory.


FreeIBLibrary procedure

See also

Frees the GDS32.DLL from memory.

Unit

procedure FreeIBLibrary;

Description

Use the FreeIBInstallLibrary procedure to free the previously loaded the GDS32.DLL from memory.


CheckIBInstallLoaded procedure

See also

Attempts to load IBInstall.DLL into memory if it is not already loaded.

Unit

procedure CheckIBInstallLoaded;

Description

Use the CheckIBInstallLibrary procedure to load IBInstall.DLL into memory if it is not already loaded.  If unsuccessful, this procedure raises an exception.


CheckIBLoaded procedure

See also

Attempts to load GDS32.DLL into memory if it is not already loaded.

Unit

procedure CheckIBLoaded;

Description

Use the CheckIBInstallLibrary procedure to load GDS32.DLL into memory if it is not already loaded.  If unsuccessful, this procedure raises an exception.


GetIBClientVersion function

See also

Returns the major version number of the InterBase client.

Unit

function GetIBClientVersion: Integer;

Description

Use the GetIBClientVersion function to retrieve the major version number of the InterBase client.


DisableMonitoring procedure

Disables SQL monitoring.

Unit

IBSQLMonitor

procedure DisableMonitoring;

Description

Use the DisableMonitoring procedure to disable SQL monitoring.


 TIBUnInstall

Hierarchy	Properties	Methods	Events	See also

Use TIBUnInstall to set up an uninstall component.

Unit

IBInstall

Description

Use TIBUnInstall to set up an uninstall component.

Note: You must install InterBase 6 to use this feature.


TIBUnInstall properties

TIBUnInstall	Alphabetically	Legend

In TIBUnInstall

UnInstallFile

Derived from TIBSetup

ErrorContext

MsgFilePath

Progress

RebootToComplete

StatusContext

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBUnInstall properties

TIBUnInstall	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

ErrorContext

MsgFilePath

Name

Owner

Progress

RebootToComplete

StatusContext

Tag

UnInstallFile

VCLComObject


TIBUnInstall.UnInstallFile

TIBUnInstall	See also

Returns the name and path of the InterBase uninstall file.

property UnInstallFile: String;

Use UnInstallFile to return the name and path of the InterBase uninstall file.

Note: You must install InterBase 6 to use this feature.


TIBUnInstall events

TIBUnInstall	Alphabetically	Legend

Derived from TIBSetup

OnError

OnStatusChange

OnWarning


TIBUnInstall events

TIBUnInstall	By object	Legend

OnError

OnStatusChange

OnWarning


TIBUnInstall methods

TIBUnInstall	Alphabetically	Legend

In TIBUnInstall

UnInstallCheck

UnInstallExecute

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBUnInstall methods

TIBUnInstall	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UnInstallCheck

UnInstallExecute

UpdateAction


TIBUnInstall.UnInstallCheck

TIBUnInstall	See also

Checks to see if uninstallation is possible.

procedure UnInstallCheck;

Description

Call UnInstallCheck to check if uninstallation is possible.

Note: You must install InterBase 6 to use this feature.


TIBUnInstall.UnInstallExecute

TIBUnInstall	See also

Executes the uninstallation.

procedure UnInstallExecute;

Description

Call UnInstallExecute to execute the uninstallation.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBSetup

TIBUnInstall


 TIBUpdateSQL

Hierarchy	Properties	Methods	See also

TIBUpdateSQL provides an object for updating read-only datasets when cached updates are enabled.

Unit

IBUpdateSQL

Description

Use a TIBUpdateSQL object to provide SQL statements used to update read-only datasets represented by TIBQuery components when cached updates are enabled. A dataset is read-only either by design or circumstance. If a dataset is read-only by design, the application itself does not provide a user interface for updating data, but may institute a programmatic scheme behind the scenes.

TIBUpdateSQL provides a mechanism for circumventing what some developers consider an SQL-92 limitation. It enables a developer to provide INSERT, UPDATE, DELETE, and REFRESH statements for performing separate update queries on otherwise read-only result sets in such a manner that the separate update queries are transparent to the end user.

In practical application, a TIBUpdateSQL object is placed on a data module or form, and linked to a TIBQuery component through that component’s UpdateObject property. If the UpdateObject property points to a valid TIBUpdateSQL object, the SQL statements belonging to the update object are automatically applied when cached updates are applied.


TIBUpdateSQL properties

TIBUpdateSQL	Alphabetically	Legend

In TIBUpdateSQL

DataSet

DeleteSQL

InsertSQL

ModifySQL

Query

SQL

Derived from TIBDataSetUpdateObject

RefreshSQL

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBUpdateSQL properties

TIBUpdateSQL	By object	Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DataSet

DeleteSQL

DesignInfo

InsertSQL

ModifySQL

Name

Owner

Query

RefreshSQL

SQL

Tag

VCLComObject


TIBUpdateSQL.DataSet

TIBUpdateSQL	See also

Identifies the dataset to which a TIBUpdateSQL component belongs.

property DataSet: TIBCustomDataSet;

Description

At design time, setting the dataset object’s UpdateObject property automatically sets the DataSet property of the specified TIBUpdateSQL object. An application should only need to set this property if it creates a new update component at run time.


TIBUpdateSQL.DeleteSQL

TIBUpdateSQL	See also

Specifies the SQL DELETE statement to use when applying a cached deletion of a record.

property DeleteSQL: TStrings;

Description

Set DeleteSQL to the SQL DELETE statement to use when applying a deletion to a record. Statements can be parameterized queries. To create a DELETE statement at design time, use the UpdateSQL editor to create statements, such as:

delete from Employee

where

Emp_No = :OLD_Emp_No

At run time, an application can write a statement directly to this property to set or change the DELETE statement.

Note:	As the example illustrates, DeleteSQL supports an extension to normal parameter binding. To retrieve the value of a field as it exists prior to application of cached updates, use the field name with the prefix ‘OLD_’. This is especially useful when doing field comparisons in the WHERE clause of the statement.


TIBUpdateSQL.InsertSQL

TIBUpdateSQL	See also

Specifies the SQL INSERT statement to use when applying a cached insertion of a record.

property InsertSQL: TStrings;

Description

Set InsertSQL to the SQL INSERT statement to use when applying an insertion to a dataset. Statements can be parameterized queries. To create a INSERT statement at design time, use the UpdateSQL editor to create statements, such as:

insert into Country

(Country, Currency)

values (:Country, :Currency)

At run time, an application can write a statement directly to this property to set or change the INSERT statement.


TIBUpdateSQL.ModifySQL

TIBUpdateSQL	See also

Specifies the SQL UPDATE statement to use when applying an update to a record and cached updates is enabled.

property ModifySQL: TStrings;

Description

Set ModifySQL to the SQL UPDATE statement to use when applying an updated record to a dataset. Statements can be parameterized queries. To create a UPDATE statement at design time, use the UpdateSQL editor to create statements, such as:

update Employee

set Last_Name = :Last_Name

where Emp_No = :OLD_Emp_No

At run time, an application can write a statement directly to this property to set or change the UPDATE statement.

Note:	As the example illustrates, ModifySQL supports an extension to normal parameter binding. To retrieve the value of a field as it exists prior to application of cached updates, the field name with ‘OLD_’. This is especially useful when doing field comparisons in the WHERE clause of the statement.


TIBUpdateSQL.Query

TIBUpdateSQL	See also

Returns the query object used to perform a specified kind of update.

property Query[UpdateKind: TUpdateKind]: TIBQuery;

Description

Query returns the TIBQuery object used to perform a particular form of SQL update. UpdateKind specifies which query object to retrieve. UpdateKind can be one of the following:

Value	Meaning

ukModify	Return the query object used to execute UPDATE statements

ukInsert	Return the query object used to execute INSERT statements

ukDelete	Return the query object used to execute DELETE statements

Each query object executes a particular kind of SQL statement. The contents of the SQL statements executed by these objects can be accessed directly using the ModifySQL, InsertSQL, and DeleteSQL properties.

The main purpose of Query is to provide a way for an application to set the properties for an update query object or to call the query object’s methods.

Note:	If a particular kind of update statement is not provided, then its corresponding query object is nil. For example, if an application does not provide an SQL statement for the DeleteSQL property, then Query[ukDelete] returns nil.


TIBUpdateSQL.SQL

TIBUpdateSQL	See also

Returns a specified SQL statement used when applying cached updates.

property SQL[UpdateKind: TUpdateKind]: TStrings;

Description

Returns the SQL statement in the ModifySQL, InsertSQL, or DeleteSQL property, depending on the setting of UpdateKind. UpdateKind can be any of the following:

Value	Meaning

ukModify	Return the SQL statement used to update records in the dataset

ukInsert	Return the SQL statement used to insert new records into the dataset

ukDelete	Return the SQL statement used to delete records in the dataset


TIBUpdateSQL methods

TIBUpdateSQL	Alphabetically	Legend

In TIBUpdateSQL

Apply

Create

Destroy

ExecSQL

SetParams

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBUpdateSQL methods

TIBUpdateSQL	By object	Legend

AfterConstruction

Apply

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Dispatch

ExecSQL

ExecuteAction

FieldAddress

FindComponent

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetParams

SetSubComponent

UpdateAction


TIBUpdateSQL.Apply

TIBUpdateSQL	See also

Sets the parameters for a specified SQL statement type, and executes the resulting statement.

procedure Apply(UpdateKind: TUpdateKind);

Description

Call Apply to set parameters for an SQL statement and execute it to update a record. UpdateKind indicates which SQL statement to bind and execute, and can be one of the following values:

Value	Meaning

ukModify	Bind and execute the SQL statement in the ModifySQL property

ukInsert	Bind and execute the SQL statement in the InsertSQL property

ukDelete	Bind and execute the SQL statement in the DeleteSQL property

Apply is primarily intended for manually executing update statements from an OnUpdateRecord event handler.

Note:	If an SQL statement does not contain parameters, it is more efficient to call ExecSQL instead of Apply.


TIBUpdateSQL.Create

TIBUpdateSQL	See also

Creates an instance of an update object.

constructor Create(AOwner: TComponent);

Description

Call Create to instantiate an update object at run time. You do not need to call Create for update objects placed in a data module or form at design time. Delphi automatically handles these objects.


TIBUpdateSQL.Destroy

TIBUpdateSQL	See also

Frees an instance of an update object.

constructor Destroy;

Description

Do not call Destroy directly in an application. Usually destruction of update objects is handled automatically by Delphi. If an application creates its own instance of an update object, however, the application should call Free, which verifies that the update object is not already freed before calling Destroy.


TIBUpdateSQL.ExecSQL

TIBUpdateSQL	See also

Executes a specified type of SQL statement to perform an update for an otherwise read-only results set when cached updates is enabled.

procedure ExecSQL(UpdateKind: TUpdateKind);

Description

Call ExecSQL to execute the SQL statement necessary for updating the records belonging to a read-only result set when cached updates is enabled. UpdateKind specifies the statement to execute, and can be one of the following values:

Value	Meaning

ukModify	Execute the SQL statement used to update records in the dataset

ukInsert	Execute the SQL statement used to insert new records into the dataset

ukDelete	Execute the SQL statement used to delete records in the dataset.

If the statement to execute contains any parameters, an application must call SetParams to bind the parameters before calling ExecSQL. To determine if a statement contains parameters, examine the appropriate ModifySQL, InsertSQL, or DeleteSQL property, depending on the statement type intended for execution.

Note:	To both bind parameters and execute a statement, call Apply.


TIBUpdateSQL.SetParams

TIBUpdateSQL	See also

Binds parameters in an SQL statement prior to statement execution.

procedure SetParams(UpdateKind: TUpdateKind);

Description

Call SetParams to bind parameters in an SQL statement associated with the update object prior to executing the statement. UpdateKind indicates the type of statement for which to bind parameters, and can be one of the following values:

Value	Meaning

ukModify	Bind parameters for the SQL statement used to update records

ukInsert	Bind parameters for the SQL statement used to insert new records

ukDelete	Bind parameters for the SQL statement used to delete records

Parameters are indicated in an SQL statement by a colon. Except for the leading colon in the parameter name, the parameter name must exactly match the name of an existing field name for the dataset.

Note:	Parameter names can be prefaced by the ‘OLD_’ indicator. If so, the old value of the field is used to perform the update instead of any updates in the cache.


Hierarchy

TObject

TPersistent

TComponent

TIBDataSetUpdateObject

TIBUpdateSQL


IBUpdateSQL and IBDataSet Editor dialog box

Use the editor to create SQL statements for updating a dataset.

The TIBUpdateSQL object must be associated with a TIBQuery object by setting the TIBQuery property UpdateObject to the name of the TIBUpdateSQL object used to contain the SQL statements. A datasource and database name must be selected for the TIBQuery object. In addition, the SQL property must include an SQL statement defining a table.

To open the SQL editor:

1.	Select the TIBUpdateSQL or TIBDataSet object in the form.

2.	Right-click and choose Update SQL editor or DataSet editor.

The Update SQL editor has two pages, the Options page and the SQL page.

The Options page

The Options page is visible when you first invoke the editor.

Table Name	Use the Table Name combo box to select the table to update. When you specify a table name, the Key Fields and Update Fields list boxes are populated with available columns.
Key Fields	The Key Fields list box is used to specify the columns to use as keys during the update. Generally the columns you specify here should correspond to an existing index.
Update Fields	The Update Fields list box indicates which columns should be updated. When you first specify a table, all columns in the Update Fields list box are selected for inclusion. You can multi-select fields as desired.
Get Table Fields	Read the table fields for the table name entered and list the fields.
Dataset Defaults	Use this button to restore the default values of the associated dataset. This will cause all fields in the Key Fields list and the Update Fields list to be selected and the table name to be restored.
Select Primary Keys	Click the Primary Key button to select key fields based on the primary index for a table.
Generate SQL	After you specify a table, select key columns, and select update columns, click the Generate SQL button to generate the preliminary SQL statements to associate with the update component’s ModifySQL, InsertSQL, DeleteSQL, and RefreshSQL properties.
Quote Identifiers	Check the box labeled Quote Field Names to specify that all field names in generated SQL be enclosed by quotation marks.  This option is disabled at this time.
The SQL page

To view, modify, and refresh the generated SQL statements, select the SQL page. If you have generated SQL statements, then when you select this page, the statement for the ModifySQL property is already displayed in the SQL Text memo box. You can edit the statement in the box as desired.

Note:	Keep in mind that generated SQL statements are intended to be starting points for creating update statements.  You may need to modify these statements to make them execute correctly. Test each of the statements directly yourself before accepting them.

Use the Statement Type radio buttons (Modify, Insert, Delete, or Refresh) to switch among generated SQL statements and edit them as desired.

To accept the statements and associate them with the update component’s SQL properties, click OK.


 TIBValidationService

Hierarchy	Properties	Methods	Events	See also

TIBValidationService enables you to validate your database and reconcile your database transactions.

Unit

IBServices

Description

Use a TIBValidationService object to validate your database and reconcile your database transactions.

Note: You must install InterBase 6 to use this feature.


TIBValidationService properties

TIBValidationService	Alphabetically	Legend

In TIBValidationService

DatabaseName

GlobalAction

LimboTransactionInfo

LimboTransactionInfoCount

Options

Derived from TIBControlAndQueryService

BufferSize

Eof

Derived from TIBControlService

IsServiceRunning

Derived from TIBCustomService

Active

Handle

LoginPrompt

Params

Protocol

ServerName

ServiceParamBySPB

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TIBValidationService properties

TIBValidationService	By object	Legend

Active

BufferSize

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DatabaseName

DesignInfo

GlobalAction

Eof

Handle

IsServiceRunning

LimboTransactionInfo

LimboTransactionInfoCount

LoginPrompt

Name

Options

Owner

Params

Protocol

ServerName

ServiceParamBySPB

Tag

LimboTransactionInfo

VCLComObject


TIBValidationService.DatabaseName

TIBValidationService	See also

Sets or returns the database name.

property DatabaseName: String;

Use DatabaseName to set or return the name of the database to be repaired.

Note: You must install InterBase 6 to use this feature.


TIBValidationService.GlobalAction

TIBValidationService	See also	Example

Sets or returns the global transaction action

type TTransactionGlobalAction = (CommitGlobal, RollbackGlobal, RecoverTwoPhaseGlobal, NoGlobalAction);

property GlobalAction: TTransactionGlobalAction;

Use GlobalAction to set or return the global transaction action.  The transaction action can be one of the following:

Transaction Action	Meaning
CommitGlobal	Commit the transactions that follow
RollbackGlobal	Roll back the transactions that follow
RecoverTwoPhaseGlobal	Perform automated two-phase commit recovery on the transactions that follow
NoGlobalAction	Take no action
Note: You must install InterBase 6 to use this feature.


TIBValidationService.Options

TIBValidationService	See also 	Example

Sets the options for the database restore.

type TValidateOption = (LimboTransactions, CheckDB, IgnoreChecksum, KillShadows, MendDB, SweepDB, ValidateDB, ValidateFull);

  TValidateOptions = set of TValidateOption;

property Options: TValidateOptions;

Use Options to select the options for the database restore.  Options are:

LimboTransactions	Return a list of limbo transactions
CheckDB	Validate the database, but don’t repair it.  Used in conjunction with ValidateDB.
IgnoreChecksum	Ignore all checksum errors
KillShadows	Kill all unavailable shadow files
MendDB	Prepare a corrupt database for backup
SweepDB	Perform a database sweep
ValidateDB	Validate the database structure
ValidateFull	Validate record fragments
Note: You must install InterBase 6 to use this feature.


TIBValidationService.LimboTransactionInfo

TIBValidationService	See also

Returns the limbo transaction information.

type

    TLimboTransactionInfo = record

    MultiDatabase: Boolean;

    ID: Integer;

    HostSite: String;

    RemoteSite: String;

    RemoteDatabasePath: String;

    State: TTransactionState;

    Advise: TTransactionAdvise;

    Action: TTransactionAction;

  end;

property LimboTransactionInfo:[Index: Integer] TLimboTransactionInfo;

Use LimboTransactionInfo to return the limbo transaction information as a TLimboTransactionInfo record.  This record contains:

Transaction ID

Host site

Remote site

Remote database path

State

Suggested action

Action

Multiple database information

Note: You must install InterBase 6 to use this feature.


TIBValidationService.LimboTransactionInfoCount

TIBValidationService	See also

Returns the number of elements in the TLimboTransactionInfo array.

property LimboTransactionInfoCount: Integer;

Use LimboTransactionInfoCount to set or return the number of elements in the TLimboTransactionInfo array.

Note: You must install InterBase 6 to use this feature.


TIBValidationService events

TIBValidationService	Alphabetically	Legend

In TIBCustomService

OnAttach

OnLogin


TIBValidationService events

TIBValidationService	By object	Legend

OnAttach

OnLogin


TIBValidationService methods

TIBValidationService	Alphabetically	Legend

In TIBValidationService

Create

Destroy

FetchLimboTransactionInfo

FixLimboTransactionErrors

Derived from TIBControlAndQueryService

GetNextChunk

GetNextLine

Derived from TIBControlService

ServiceStart

Derived from TIBCustomService

Attach

Detach

Derived from TComponent

BeforeDestruction

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsImplementorOf

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

SetSubComponent

UpdateAction

Derived from TPersistent

Assign

Derived from TObject

AfterConstruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance


TIBValidationService methods

TIBValidationService	By object	Legend

AfterConstruction

Assign

Attach

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

DestroyComponents

Destroying

Detach

Dispatch

ExecuteAction

FetchLimboTransactionInfo

FieldAddress

FindComponent

FixLimboTransactionErrors

Free

FreeInstance

FreeNotification

FreeOnRelease

GetInterface

GetInterfaceEntry

GetInterfaceTable

GetNamePath

GetNextChunk

GetNextLine

GetParentComponent

HasParent

InheritsFrom

InitInstance

InsertComponent

InstanceSize

IsImplementorOf

MethodAddress

MethodName

NewInstance

ReferenceInterface

RemoveComponent

RemoveFreeNotification

SafeCallException

ServiceStart

SetSubComponent

UpdateAction


TIBValidationService.Create

TIBValidationService	See also

Creates an instance of TIBValidationService

constructor Create(AOwner: TComponent);

Description

Call Create to create an instance of TIBValidationService.

Note: You must install InterBase 6 to use this feature.


TIBValidationService.Destroy

TIBValidationService	See also

Destroys the service.

destructor Destroy;

Description

Do not call Destroy directly in an application. Instead, an application should call Free. Free verifies that the service object has not already been freed before it calls Destroy.

Note: You must install InterBase 6 to use this feature.


TIBValidationService.FetchLimboTransactionInfo

TIBValidationService	See also

Gets limbo transaction information.

function FetchLimboTransactionInfo;

Description

Call FetchLimboTransactionInfo to get limbo transaction information from the LimboTransactionInfo property.

Note: You must install InterBase 6 to use this feature.


TIBValidationService.FixLimboTransactionErrors

TIBValidationService	See also

Fixes limbo transaction errors.

function FixLimboTransactionErrors;

Description

Call FixLimboTransactionErrors to repair limbo transaction errors.

Note: You must install InterBase 6 to use this feature.


Hierarchy

TObject

TPersistent

TComponent

TIBCustomService

TIBControlService

TIBControlAndQueryService

TIBValidationService


 TIBXSQLDA

Hierarchy	Properties	Methods	See also

TIBXSQLDA provides properties and methods for use with the IBSQL component.

Unit

IBSQL

Description

Use a TIBXSQLDA object to provide properties and methods for use with the IBSQL component.

All Dynamic SQL (DSQL) applications must declare one or more extended descriptor areas (XSQLDAs).  The XSQLDA is a host language data structure that DSQL uses to transport data to or from a database when processing an SQL statement string.  There are two types of XSQLDAs: input descriptors and output descriptors.  Both input and output descriptors are implemented using the XSQLDA structure.


TIBXSQLDA properties

TIBXSQLDA	Alphabetically	Legend

In TIBXSQLDA

AsXSQLDA

Count

Modified

Names

RecordSize

UniqueRelationName

Vars


TIBXSQLDA properties

TIBXSQLDA	By object	Legend

AsXSQLDA

Count

Modified

Names

RecordSize

UniqueRelationName

Vars


TIBXSQLDA.AsXSQLDA

TIBXSQLDA

Represents the XSQLDA field’s value as an XSQLDA value.

property AsXSQLDA: PXSQLDA;

Description

Use the AsXSQLDA property to read the value of the field’s data into an object or variable of type XSQLDA, or to assign an XSQLDA value to the contents of the field.


TIBXSQLDA.Count

TIBXSQLDA

Returns the number of XSQLDA fields.

property Count: Integer;

Description

Use the Count property to return the number of XSQLDA fields.


TIBXSQLDA.Modified

TIBXSQLDA

Indicates whether a field has been modified.

property Modified: Boolean;

Description

Use the Modified property to determine whether a field has been modified.


TIBXSQLDA.Names

TIBXSQLDA	See also

Returns the XSQLDA field names.

property Names: String;

Description

Use the Names property to return the XSQLDA field names.


TIBXSQLDA.RecordSize

TIBXSQLDA

Returns the size of the XSQLDA record.

property RecordSize: Integer;

Description

Use the RecordSize property to return the XSQLDA record size.


TIBXSQLDA.UniqueRelationName

TIBXSQLDA

Returns the name of the unique relation.

property UniqueRelationName: String;

Description

Use the UniqueRelationName property to return the name of the relation if only one relation is involved in the query.  Otherwise, it returns nil. This property is primarily used for internal purposes.


TIBXSQLDA.Vars

TIBXSQLDA

Returns the XSQLVAR defined for the XSQLDA parameter.

property Vars: [Idx: Integer]: TIBXSQLVAR; default;

Description

Use Vars to return the XSQLVAR defined for the XSQLDA parameter.

Vars is the default property for TIBXSQLDSA, which means that the name of the Vars property can be omitted when the TIBXSQLDA object implements a property in another object.


TIBXSQLDA methods

TIBXSQLDA	Alphabetically	Legend

In TIBXSQLDA

AddName

ByName

Create

Destroy

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBXSQLDA methods

TIBXSQLDA	By object	Legend

AddName

AfterConstruction

BeforeDestruction

ByName

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBXSQLDA.AddName

TIBXSQLDA	See also

Adds a name to the XSQLDA structure.

procedure AddName(FieldName: String; Idx: Integer);

Description

Call AddName to add a name to the XSQLDA structure.


TIBXSQLDA.ByName

TIBXSQLDA

Returns the XSQLVAR fields by name.

function ByName: (Idx: String): TIBXSQLVAR;

Description

Use the ByName function to return the XSQLVAR fields by name.


TIBXSQLDA.Create

TIBXSQLDA	See also

Creates an instance of an XSQLDA structure.

constructor Create(Query: TIBSQL);

Description

Call Create to create an instance of an XSQLDA structure. Create queries the DynamicSQL component for the structure members.


TIBXSQLDA.Destroy

TIBXSQLDA	See also

Destroys the XSQLDA structure.

destructor Destroy;

Description

Do not call Destroy directly. Call Free instead. Free checks to ensure that the object instance is not nil before calling Destroy.


Hierarchy

TObject

TIBXSQLDA


TIBXSQLVAR

Hierarchy	Properties	Methods	See also

TIBXSQLVAR provides properties and methods for use with the IBSQL component.

Unit

IBSQL

Description

Use a TIBXSQLVAR object to provide properties and methods for use with the IBSQL component.

The XSQLVAR structure is a field, sqlvar, in the XSQLDA.  The sqlvar is especially important, because one XSQLVAR must be defined for each input parameter or column returned.

Applications do not declare instances of the XSQLVAR ahead of time, but must, instead, dynamically allocate storage for the proper number of XSQLVAR structures required for each DSQL statement before it is executed, then deallocate it, as appropriate, after statement execution.


TIBXSQLVAR properties

TIBXSQLVAR	Alphabetically	Legend

In TIBXSQLVAR

AsCurrency

AsDate

AsDateTime

AsDouble

AsFloat

AsInt64

AsInteger

AsLong

AsPointer

AsQuad

AsShort

AsString

AsTime

AsTrimString

AsVariant

AsXSQLVAR

Data

Index

IsNull

IsNullable

Modified

Name

Size

SQLType

Value


TIBXSQLVAR properties

TIBXSQLVAR	By object	Legend

AsCurrency

AsDate

AsDateTime

AsDouble

AsFloat

AsInt64

AsInteger

AsLong

AsPointer

AsQuad

AsShort

AsString

AsTime

AsTrimString

AsVariant

AsXSQLVAR

Data

Index

IsNull

IsNullable

Modified

Name

Size

SQLType

Value


TIBXSQLVAR.AsCurrency

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a Currency value.

property AsCurrency: Currency;

Use the AsCurrency property to read the value of the XSQLVAR field’s data into an object or variable of type Currency, or to assign a Currency value to the contents of the field.


TIBXSQLVAR.AsDate

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a TDateTime value.

property AsDate: TDateTime;

Description

Use the AsDate property to read the value of the field’s data into an object or variable of type TDateTime, or to assign a TDateTime value to the contents of the field.  The Time portion of the TDateTime value is set to zero.


TIBXSQLVAR.AsDateTime

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a TDateTime value.

property AsDateTime: TDateTime;

Description

Use the AsDateTime property to read the value of the field’s data into an object or variable of type TDateTime, or to assign a TDateTime value to the contents of the field.


TIBXSQLVAR.AsDouble

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a Double value.

property AsDouble: Double;

Description

Use the AsDouble property to read the value of the field’s data into an object or variable of type Double, or to assign a Double value to the contents of the field.


TIBXSQLVAR.AsFloat

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a Float value.

property AsFloat: Float;

Description

Use the AsDouble property to read the value of the field’s data into an object or variable of type Float, or to assign a Float value to the contents of the field.


TIBXSQLVAR.AsInt64

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a 64-bit integer.

property AsInt64: Int64;

Description

Use the AsInt64 property to read the value of the field’s data into a 64-bit integer, or to assign an 64-bit integer value to the contents of the field.


TIBXSQLVAR.AsInteger

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a 32-bit integer value.

property AsInteger: AsInteger;

Description

Use the AsInteger property to read the value of the field’s data into an integer, or to assign an integer value to the contents of the field.


TIBXSQLVAR.AsLong

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a Long integer value.

property AsLong: Long;

Description

Use the AsLong property to read the value of the field’s data into a Long integer, or to assign a Long integer value to the contents of the field.


TIBXSQLVAR.AsPointer

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a Pointer value.

property AsPointer: Pointer;

Description

Use the AsPointer property to read the value of the field’s data into an object or variable of type Pointer, or to assign a Pointer value to the contents of the field.


TIBXSQLVAR.AsQuad

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a Quad value.

property AsQuad: TISC_QUAD;

Description

Use the AsQuad property to read the value of the field’s data into an object or variable of type Quad, or to assign a Quad value to the contents of the field.


TIBXSQLVAR.AsShort

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a Short integer value.

property AsShort: Short;

Description

Use the AsShort property to to read the value of the field’s data into a Short integer, or to assign a Short integer value to the contents of the field.


TIBXSQLVAR.AsString

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a string.

property AsString: String;

Description

Use the AsString property to read the value of the field’s data into a string, or to assign a String value to the contents of the field.


TIBXSQLVAR.AsTime

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a TDateTime value.

property AsTime: TDateTime;

Description

Use the AsTime property to read the value of the field’s data into an object or variable of type TDateTime, or to assign a TDateTime value to the contents of the field.  The Date portion of the field is set to zero.


TIBXSQLVAR.AsTrimString

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as a string with any trailing spaces removed.

property AsTrimString: String;

Description

Use the AsTrimString property to read the value of the field’s data into a string, removing any trailing spaces from the value.

When assigning AsTrimString, any trailing spaces in the assigned string are removed before assigning the value. The spaces do not become part of the underlying value.


TIBXSQLVAR.AsVariant

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as type Variant.

property AsVariant: Variant;

Description

Use the AsVariant property to read the value of the field’s data into a Variant, or to assign a Variant value to the contents of the field.


TIBXSQLVAR.AsXSQLVAR

TIBXSQLVAR	See also

Represents the XSQLVAR field’s value as an XSQLVAR value.

property AsXSQLVAR: PXSQLVAR;

Description

Use the AsXSQLVAR property to read the value of the field’s data into an object or variable of type XSQLVAR, or to assign an XSQLVAR value to the contents of the field.


TIBXSQLVAR.Data

TIBXSQLVAR	See also

Accesses the underlying InterBase XSQLVAR structure.

property Data: PXSQLVAR;

Description

Use the Data property to access the underlying InterBase XSQLVAR structure.


TIBXSQLVAR.Index

TIBXSQLVAR

Indicates the position of the XSQLVAR in the XSQLDA.

property Index: Integer;

Description

Use the Index property to obtain the position of the XSQLVAR in the XSQLDA.


TIBXSQLVAR.IsNull

TIBXSQLVAR	See also

Indicates whether the field has a value assigned to it.

property IsNull: Boolean;

Description

Use the IsNull property to determine if the field contains a value. If IsNull is Truethe field is blank. If IsNull is False, the field has a value.


TIBXSQLVAR.IsNullable

TIBXSQLVAR	See also

Indicates whether the field can have a value assigned to it.

property IsNullable: Boolean;

Description

Use the IsNullable property to determine if the field can contain a value. If IsNullable is True, the field can contain a value. If IsNullable is False, the field cannot contain a value.


TIBXSQLVAR.Modified

TIBXSQLVAR	See also

Indicates whether a field has been modified.

property Modified: Boolean;

Description

Use the Modified property to determine whether a field has been modified.


TIBXSQLVAR.Name

TIBXSQLVAR	See also

Returns the name of the XSQLVAR.

property Name: String;

Description

Use the Name property to return the name of the XSQLVAR.


TIBXSQLVAR.Size

TIBXSQLVAR	See also

Indicates the maximum size, in bytes, of data in the sqldata field of the XSQLVAR.

property Size: Integer;

Description

Use the Size property to return the maximum size, in bytes, of data in the sqldata field of the XSQLVAR.


TIBXSQLVAR.SQLType

TIBXSQLVAR	See also

Indicates the SQL datatype of parameters or select-list items.

property SQLType: Integer;

Description

Read the SQLType property to indicate the SQL datatype of parameters or select-list items.


TIBXSQLVAR.Value

TIBXSQLVAR	See also

Returns the value of the XSQLVAR field component.

property Value: Variant;

Description

Use Value to return the value of the XSQLVAR field component as a Variant.


TIBXSQLVAR methods

TIBXSQLVAR	Alphabetically	Legend

In TIBXSQLVAR

Assign

Clear

Create

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream

Derived from TObject

AfterConstruction

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

MethodAddress

MethodName

NewInstance

SafeCallException


TIBXSQLVAR methods

TIBXSQLVAR	By object	Legend

AfterConstruction

Assign

BeforeDestruction

ClassInfo

ClassName

ClassNameIs

ClassParent

ClassType

CleanupInstance

Clear

Create

DefaultHandler

Destroy

Dispatch

FieldAddress

Free

FreeInstance

GetInterface

GetInterfaceEntry

GetInterfaceTable

InheritsFrom

InitInstance

InstanceSize

LoadFromFile

LoadFromStream

MethodAddress

MethodName

NewInstance

SafeCallException

SaveToFile

SaveToStream


TIBXSQLVAR.Assign

TIBXSQLVAR	See also

Assigns another XSQLVAR to the XSQLVAR component.

procedure Assign(Source: TIBXSQLVAR);

Description

Use Assign to assign another XSQLVAR to the XSQLVAR component. The fields must have compatible data types.


TIBXSQLVAR.Clear

TIBXSQLVAR	See also

Clears the value of this TIBXSQLVar object.

procedure Clear;

Description

Call Clear to assign a Null value to this TIBXSQLVar object.


TIBXSQLVAR.Create

TIBXSQLVAR

Creates an instance of an XSQLVAR structure.

constructor Create(Parent: TIBXSQLDA; Query: TIBSQL);

Description

Call Create to create an instance of TIBXSQLVAR.

Parent is an extended descriptor area that defines the namespace to use for processing the variable name.

Query identifies the query that includes this variable.


TIBXSQLVAR.LoadFromFile

TIBXSQLVAR	See also

Loads the contents of a file to a Blob field.

procedure LoadFromFile(const FileName: String);

Description

Call LoadFromFile to load the contents of a file to a Blob field.


TIBXSQLVAR.LoadFromStream

TIBXSQLVAR	See also

Loads a stream into a Blob field.

procedure LoadFromStream(Stream: TStream);

Description

Call LoadFromStream to load a stream into a Blob field.


TIBXSQLVAR.SaveToFile

TIBXSQLVAR	See also

Saves the contents of a Blob field to a file.

procedure SaveToFile(const FileName: String);

Description

Call SaveToFile to save the contents of a Blob field to a file.


TIBXSQLVAR.SaveToStream

TIBXSQLVAR	See also

Saves the contents of a Blob field to a stream.

procedure SaveToStream(Stream: TStream);

Description

Call SaveToStream to save the contents of a Blob field to a stream.


Hierarchy

TObject

TIBXSQLVAR


IIBEventNotifier

Hierarchy	Methods	See also

IIBEventNotifier allows a TIBDatabase component to automatically register interest in events on the InterBase server.

Unit

IBDataBase

Description

TIBDatabase uses the IIBEventNotifier interface to communicate with objects such as TIBEvents that register an interest in events on the InterBase server.


IIBEventNotifier methods

IIBEventNotifier	Alphabetically	Legend

In IIBEventNotifier

GetAutoRegister

RegisterEvents

UnRegisterEvents

Derived from IInterface

_AddRef

_Release

QueryInterface


IIBEventNotifier methods

IIBEventNotifier	By object	Legend

_AddRef

_Release

GetAutoRegister

QueryInterface

RegisterEvents

UnRegisterEvents


IIBEventNotifier.GetAutoRegister

IIBEventNotifier	See also

Indicates whether the database should automatically register events after it connects to the server.

function GetAutoRegister: Boolean;

Description

When TIBDatabase connects to an InterBase server, it calls the GetAutoRegister method for every object in its list of event notifiers. For any event notifier that returns True, it calls the RegisterEvents method, so that the event notifier can register interest in its events with the InterBase Event Manager.


IIBEventNotifier.RegisterEvents

IIBEventNotifier	See also

Registers interest in a set of events with the InterBase Event manager.

procedure RegisterEvents;

Description

RegisterEvents tells the event notifier to register its interest in a set of events with the InterBase Event manager.


IIBEventNotifier.UnRegisterEvents

IIBEventNotifier	See also

Unregisters interest in the events previously registered by a call to RegisterEvents.

procedure UnRegisterEvents;

Description

UnRegisterEvents cancels the interest in the events that was previously registered by a call to RegisterEvents. TIBDataBase uses this interface to unregister all of its event notifiers  when it disconnects from the InterBase server.


Hierarchy

IIBEventNotifier


Scope

Published

Protected

Accessibility

Read-only


Scope

Published

Protected

Accessibility

Read-only


Scope

Published

Protected

Accessibility

Read-only


IBBatchMove unit

Other objects and components, by unit

TIBBatchMove

TIBBatchMove enables applications to perform database operations on groups of records or entire tables.


IBBlob unit

Other objects and components, by unit

TIBBlobStream

TIBBlobStream is a stream object that lets applications read from or write to field objects that represent Blob fields.


IBCustomDataSet unit

Other objects and components, by unit

TIBBCDField

TIBBCDField represents a numeric field as a Currency type..

TIBCustomDataSet

TIBCustomDataSet is the base class for all datasets that represent data fetched using InterBase Express.

TIBDataLink

TIBDataLink is a helper class used by data-aware objects to coordinate the actions of TIBDataSet and to respond to data events.

TIBDataSet

TIBDataSet executes InterBase SQL statements.

TIBDataSetUpdateObject

TIBDataSetUpdateObject is the abstract base class for update objects used to update otherwise un-updateable queries when cached updates are enabled.

TIBDSBlobStream

TIBDSBlobStream reads from and writes to BLOB fields on behalf of an IB Dataset.

TIBGeneratorField

TIBGeneratorField calls the server to generate values for a field in an IB dataset.

TIBStringField

TIBStringField allows for strings in excess of 8196 bytes of data.


IBDatabaseInfo unit

Other objects and components, by unit

TIBDatabaseInfo

TIBDatabaseInfo returns information about the attached database.


IBDataBase unit

Other objects and components, by unit

IIBEventNotifier

IIBEventNotifier allows a TIBDatabase component to automatically register interest in events on the InterBase server.

TIBBase

TIBBase is the ancestor object from which TIBTransaction descends.

TIBDatabase

TIBDatabase encapsulates an InterBase database connection.

TIBTransaction

TIBTransaction provides discrete transaction control over a one or more database connections in a database application.


IBEvents unit

Other objects and components, by unit

TIBEvents

TIBEvents enables applications to respond to posted events.


IBExtract unit

Other objects and components, by unit

TIBExtract

TIBExtract fetches metadata from an InterBase server.


IBInstall unit

Other objects and components, by unit

EIBInstall

EIBInstall catches all of the installation exceptions.

TIBInstall

Use TIBInstall to set up an InterBase installation component.

TIBSetup

TIBSetup is the ancestor object from which TIBInstall and TIBUnInstall are derived.

TIBUnInstall

Use TIBUnInstall to set up an uninstall component.

TInstallOptions

Use TInstallOptions to configure the TIBInstall.Options property.


IBQuery unit

Other objects and components, by unit

TIBQuery

TIBQuery executes an InterBase SQL statement.


IBServices unit

Other objects and components, by unit

TIBBackupRestoreService

TIBBackupRestoreService is the ancestor object from which TIBBackupService and TIBRestoreService are derived.

TIBBackupService

TIBBackupService allows you to back up your database.

TIBConfigService

TIBConfigService configures the database parameters

TIBControlAndQueryService

TIBControlAndQueryService is the ancestor object from which the log, statistical, validation, security, and backup and restore IBService components descend.

TIBControlService

TIBControlService is the ancestor object from which the structured and unstructured IBService components descend.

TIBCustomService

TIBCustomService is the ancestor object from which all IBService components descend.

TIBLicensingService

TIBLicensingService configures the licensing parameters

TIBLogService

TIBLogService returns the contents of the interbase.log file from a server.

TIBRestoreService

TIBRestoreService allows you to restore your database.

TIBSecurityService

TIBSecurityService enables you to manage user access to the InterBase server.

TIBServerProperties

TIBServerProperties returns database server information.

TIBStatisticalService

TIBStatisticalService allows you to view database statistics.

TIBValidationService

TIBValidationService enables you to validate your database and reconcile your database transactions.


IBSQLMonitor unit

IBSQLMonitor routines

Other objects and components, by unit

TIBCustomSQLMonitor

TIBCustomSQLMonitor is the ancestor for TIBSQLMonitor.

TIBSQLMonitor

TIBSQLMonitor monitors dynamic SQL passed to the InterBase server.


IBSQL unit

Other objects and components, by unit

TIBBatch

TIBBatch is the abstract base class for the TIBBatchInput and TIBBatchOutput objects.

TIBBatchInput

TIBBatchInput is the abstract class for performing all batch input.

TIBSQL

TIBSQL provides an object for executing an InterBase SQL statement with minimal overhead.

TIBXSQLDA

TIBXSQLDA provides properties and methods for use with the IBSQL component.

TIBXSQLVAR

TIBXSQLVAR provides properties and methods for use with the IBSQL component.


IBStoredProc unit

Other objects and components, by unit

TIBStoredProc

TIBStoredProc encapsulates a stored procedure on a database server.


IBTable unit

Other objects and components, by unit

TIBMasterDataLink

TIBMasterDataLink allows a dataset to establish a master/detail relationship.

TIBTable

TIBTable is a dataset component that encapsulates a database table.


IBUpdateSQL unit

Other objects and components, by unit

TIBUpdateSQL

TIBUpdateSQL provides an object for updating read-only datasets when cached updates are enabled.


IB unit

IB routines

Other objects and components, by unit

EIBClientError

EIBClientError represents a client-specific error in an InterBase Express application.

EIBError

EIBError is the exception class for InterBase errors.

EIBInterBaseError

EIBInterBaseError is used to raise server-specific errors.

EIBInterbaseRoleError

EIBInterbaseRoleError is the exception class for InterBase errors that arise when a caller’s role does not have sufficient rights.


IBSQLMonitor routines

IBSQLMonitor objects/components

Other routines, by unit

DisableMonitoring procedure

Disables SQL monitoring.


IB routines

IB objects/components

Other routines, by unit

CheckStatusVector function

Sets or unsets status vector checking.

GetIBDataBaseErrorMessages function

Returns the current error message setting.

IBAlloc procedure

Allocates or de-allocates memory for a given size, and initializes the new memory to zero.

IBDataBaseError procedure

Interprets the SQLCode and IBErrorCode status and passes it to the EIBInterBaseError exception.

IBError procedure

Returns the error message for the specified error code.

SetIBDataBaseErrorMessages procedure

Enables you to choose the error messages you want to see.

StatusVector function

Retrieves the thread-specific status vector from thread-local storage.

StatusVectorArray function

Returns a pointer to the status vector array.

StatusVectorAsText function

Gets the status vector and returns it as a formatted string.


All elements are displayed here

No additional elements exist for this unit/header or routine.


Link not found

The topic you requested is either not available or not linked to this Help system. This can occur if you launched this Help file from a system on which Delphi has not yet been installed, or if the subject matter you are requesting is not available in your edition of Delphi.


The topic you requested is now loading. If it does not appear within a few seconds, the topic is either not available or not linked to this Help system. This can occur if you launched this Help file from a system on which Delphi has not yet been installed, or if the subject matter you are requesting is not available in your edition of Delphi.