TSQLConnection Members

The following tables list the members exposed by TSQLConnection.

	Name	Description
	FComponentStyle	FComponentStyle is the field of the ComponentStyle read-only property.

Protected Methods

	Name	Description
	_AddRef	Called when an application uses a component interface.
	_Release	Called when an application releases a component interface.
	AssignTo	Copies the properties of an object to a destination object.
	ChangeName	Sets the private, internal storage for the Name property to the string passed in NewName.
	CheckConnection	This is CheckConnection, a member of class TSQLConnection.
	CheckDisconnect	This is CheckDisconnect, a member of class TSQLConnection.
	ConnectionOptions	This is ConnectionOptions, a member of class TSQLConnection.
	DefineProperties	Designates methods for storing an object's unpublished data on a stream such as a form file.
	DefineProperties	Provides an interface for a method that reads and writes otherwise unpublished data.
	DoConnect	Provides the interface for a method that opens a connection.
	DoDisconnect	Provides the interface for a method that terminates the connection.
	GetChildOwner	Returns the owner of a child component being read from a stream.
	GetChildParent	Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.
	GetChildren	Enumerates all child components.
	GetConnected	Returns the value of the Connected property.
	GetDataSet	Returns a dataset, given its index in the DataSets property array.
	GetDataSetCount	Returns the value of the DataSetCount property.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	Invoke	Provides access to Automation properties and methods when the component wraps an Automation object.
	Loaded	Initializes the connection component after all objects in the form or data module have been loaded.
	Notification	Forwards notification messages to all owned components.
	OpenSchema	This is the overview for the OpenSchema method overload.
	PaletteCreated	Responds when the component is created from the component palette.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	Reads the state of the component.
	RegisterClient	Registers an object that uses the connection component.
	SendConnectEvent	Informs all registered clients that use the connection component when a connection is opened or closed.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetChildOrder	Sets the visual ordering of a child control.
	SetConnected	Changes the value of the Connected property.
	SetDesigning	Ensures that components inserted at design time have their design-mode flag set.
	SetDesignInstance	Ensures that components inserted at design time have their design-mode flag set.
	SetInline	Sets the csInline bit of the component's ComponentState property
	SetName	Sets the value of the Name property.
	SetParentComponent	Sets the parent component.
	SQLError	This is SQLError, a member of class TSQLConnection.
	UnRegisterClient	Removes a registered client so that it is no longer associated with the connection component.
	Updated	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
	UpdateRegistry	Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
	Updating	Sets the csUpdating state in the component's ComponentState property.
	ValidateContainer	Determines whether an object can be inserted into a container.
	ValidateInsert	Provides the interface for a method that validates an child component before it is inserted.
	ValidateRename	Ensures that renaming an owned component does not create name conflict.
	WriteState	Writes the state of the component.

Protected Properties

	Name	Description
	ConnectionRegistryFile	This is ConnectionRegistryFile, a member of class TSQLConnection.
	QuoteChar	This is QuoteChar, a member of class TSQLConnection.
	SQLDllHandle	This is SQLDllHandle, a member of class TSQLConnection.
	StreamedConnected	Indicates whether the Connected property was true when the connection component was loaded from a stream.

Public Events

	Name	Description
	TraceCallbackEvent	Provides access to the callback function that executes for every SQL command passed to or from the server.

Public Methods

	Name	Description
	_AddRef	Increments the reference count for this interface.
	_Release	Decrements the reference count for this interface.
	AddConnectNotification	This is AddConnectNotification, a member of class TSQLConnection.
	AfterConstruction	Responds after the last constructor has executed.
	Assign	Copies the contents of another, similar object.
	BeforeDestruction	Performs any necessary actions before the first destructor is called.
	BeforeDestruction	Responds before the first destructor executes.
	BeginTransaction	This is the overview for the BeginTransaction method overload.
	ClassInfo	Returns a pointer to the runtime type information (RTTI) table for the object type.
	ClassName	Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
	ClassNameIs	Determines whether an object is of a specific type.
	ClassParent	Returns the type of the immediate ancestor of a class.
	ClassType	Returns the class reference for the object's class.
	CleanupInstance	Performs finalization on long strings, variants, and interface variables within a class.
	CloneConnection	Returns a copy of the SQL connection object.
	Close	Closes the connection.
	CloseDataSets	Closes all datasets associated with the SQL connection object component without disconnecting from the database.
	Commit	Commits an open transaction.
	CommitFreeAndNil	Commits an open transaction.
	Create	Creates and initializes an instance TSQLConnection.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Destroys the SQL connection object.
	DestroyComponents	Destroys all owned components.
	Destroying	Indicates that the component and its owned components are about to be destroyed.
	Dispatch	Calls message-handling methods for the object, based on the contents of the Message parameter.
	Equals	Checks if the current instance and the parameter are equal.
	Execute	Executes an SQL command on the server.
	ExecuteAction	Executes an action.
	ExecuteDirect	Executes an SQL command that does not include parameters.
	FieldAddress	This is the overview for the FieldAddress method overload.
	FindComponent	Indicates whether a given component is owned by the component.
	Free	Destroys an object and frees its associated memory, if necessary.
	FreeInstance	Deallocates memory allocated by a previous call to the System::TObject::NewInstance method.
	FreeNotification	Ensures that AComponent is notified that the component is going to be destroyed.
	FreeOnRelease	Frees the interface reference for components that were created from COM classes.
	GetCommandTypes	This is GetCommandTypes, a member of class TSQLConnection.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetDefaultSchemaName	Returns the default schema name of the current object.
	GetEnumerator	Returns a TComponent enumerator.
	GetFieldNames	This is the overview for the GetFieldNames method overload.
	GetHashCode	Returns an integer containing the hash code.
	GetIndexNames	This is the overview for the GetIndexNames method overload.
	GetInterface	Retrieves a specified interface.
	GetInterfaceEntry	Returns the entry for a specific interface implemented in a class.
	GetInterfaceTable	Returns a pointer to a structure containing all of the interfaces implemented by a given class.
	GetLoginUsername	Returns the username that is logged in on the current connection.
	GetNamePath	Returns a string used by the Object Inspector.
	GetNamePath	Returns the name of the object as it appears in the Object Inspector.
	GetPackageNames	This is the overview for the GetPackageNames method overload.
	GetParentComponent	Returns the containing Component.
	GetProcedureNames	This is the overview for the GetProcedureNames method overload.
	GetProcedureParams	This is the overview for the GetProcedureParams method overload.
	GetSchemaNames	This is the overview for the GetSchemaNames method overload.
	GetServerMethodNames	This is GetServerMethodNames, a member of class TSQLConnection.
	GetTableNames	This is the overview for the GetTableNames method overload.
	HasParent	Verifies whether the component has a parent.
	HasTransaction	This is HasTransaction, a member of class TSQLConnection.
	InheritsFrom	Determines the relationship of two object types.
	InitInstance	Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
	InsertComponent	Establishes the component as the owner of a specified component.
	InstanceSize	Returns the size in bytes of each instance of the object type.
	IsImplementorOf	Indicates whether the component implements a specified interface.
	LoadParamsFromIniFile	Sets the DriverName and Params properties to the values associated with the ConnectionName property.
	MethodAddress	This is the overview for the MethodAddress method overload.
	MethodName	Returns the name of a class method by address.
	NewInstance	Allocates memory for an instance of an object type and returns a pointer to that new instance.
	Open	Opens the connection.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReferenceInterface	Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
	RemoveComponent	Removes a specified component specified from the component's Components list.
	RemoveConnectNotification	This is RemoveConnectNotification, a member of class TSQLConnection.
	RemoveFreeNotification	Disables destruction notification that was enabled by FreeNotification
	Rollback	Cancels all updates, insertions, and deletions for a specified transaction and ends the transaction.
	RollbackFreeAndNil	Cancels all updates, insertions, and deletions for a specified transaction and ends the transaction.
	RollbackIncompleteFreeAndNil	Cancels all updates, insertions, and deletions for a specified transaction and ends the transaction.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SetSubComponent	Identifies whether the component is a subcomponent.
	SetTraceEvent	Associates the SQL connection with a callback function that executes for every SQL command passed to or from the server.
	StartTransaction	Initiates a new transaction in the associated database.
	ToString	Returns a string containing the class name.
	UnitName	Returns a string containing the unit name.
	UpdateAction	Updates the state of an action.

Public Properties

	Name	Description
	ActiveStatements	Indicates the number of statements currently active with the database server.
	AutoClone	Specifies whether the SQL connection automatically clones database connections when they are needed.
	ComObject	Specifies the interface reference implemented by the component.
	ComponentCount	Indicates the number of components owned by the component.
	ComponentIndex	Indicates the position of the component in its owner's Components property array.
	Components	Lists all components owned by the component.
	ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
	ComponentStyle	Governs the behavior of the component.
	ConnectionData	This is ConnectionData, a member of class TSQLConnection.
	ConnectionState	Indicates the current state of the TSQLConnection object.
	DataSetCount	Indicates the number of datasets associated with the connection component.
	DataSets	Lists all active datasets for the connection component.
	DBXConnection	Provides an interface to the dbExpress object that represents a connection.
	DesignInfo	Contains information used by the Form designer.
	InTransaction	Indicates whether a transaction is in progress.
	LocaleCode	Identifies the locale that is used for sorting items from datasets that use this connection.
	MaxStmtsPerConn	Indicates the server limit on the number of statements supported by a single database connection.
	MetaData	Provides an interface to the dbExpress object that supplies server metadata.
	MultipleTransactionsSupported	Indicates whether the database server supports multiple transactions.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	ParamsLoaded	Indicates when parameter values have been loaded from dbxconnections.ini.
	SQLHourGlass	Specifies whether the cursor should change to crSQLWait during lengthy operations.
	TransactionsSupported	Indicates whether the database server supports transactions.
	VCLComObject	Represents information used internally by components that support COM.

Published Events

	Name	Description
	AfterConnect	Occurs after a connection is established.
	AfterDisconnect	Occurs after the connection closes.
	BeforeConnect	Occurs immediately before establishing a connection.
	BeforeDisconnect	Occurs immediately before the connection closes.
	OnLogin	Occurs after the BeforeConnect event and before a connection is established.

Published Properties

	Name	Description
	Connected	Specifies whether the connection is active.
	ConnectionName	Names the connection configuration.
	DriverName	Specifies the database driver associated with the SQL connection.
	GetDriverFunc	Specifies the function that returns the top-level dbExpress driver.
	KeepConnection	Specifies whether the connection stays active when no datasets are open.
	LibraryName	Specifies the dbExpress driver that TSQLConnection uses to establish a connection.
	LoadParamsOnConnect	Specifies whether the TSQLConnection component loads the configuration named by ConnectionName immediately before connecting to the server.
	LoginPrompt	Specifies whether a login dialog appears immediately before opening a new connection.
	Name	Specifies the name of the component as referenced in code.
	Params	Lists the connection parameters.
	TableScope	Indicates what types of tables are returned when fetching schema information about tables.
	Tag	Stores an integer value as part of a component.
	VendorLib	Specifies the client software library (DLL or shared object) supplied by the database vendor.

What do you think about this topic? Send feedback!