Sign in Join
FPDoc Onlineexperiment

TCustomConnection class

In unit DB

Abstract class for connections to a server.

Declaration

pascal
TCustomConnection = class(TComponent)

Inheritance

  1. TCustomConnection
  2. TComponent
  3. TPersistent
  4. TObject

Descends from it: TDatabase

Description

TCustomConnection must be used for all database classes that need a connection to a server. The class introduces some methods and classes to activate the connection ( Open) and to deactivate the connection ( Close), plus a property to inspect the state ( Connected) of the connected.

See also

Properties

ForcedCloseprotected
StreamedConnectedprotected
DataSetCountpublicNumber of datasets connected to this connection.
DataSetspublicDatasets linked to this connection.
ConnectedpublishedIs the connection established or not.
LoginPromptpublishedShould the OnLogin be triggered.
AfterConnectpublishedEvent triggered after a connection is made.
AfterDisconnectpublishedEvent triggered after a connection is closed.
BeforeConnectpublishedEvent triggered before a connection is made.
BeforeDisconnectpublishedEvent triggered before a connection is closed.

Methods

DoCloseErrorprotected
SetForcedCloseprotected
CloseForDestroyprotected
DoLoginPromptprotected
DoConnectprotected
DoDisconnectprotected
GetConnectedprotected
GetDatasetprotected
GetDataSetCountprotected
GetLoginParamsprotected
InternalHandleExceptionprotected
LoadedprotectedCalled when the component has finished loading.
SetConnectedprotected
SetLoginParamsprotected
ClosepublicClose the connection.
DestroypublicRemove the TCustomconnection instance from memory.
OpenpublicMakes the connection to the server.

Events

OnLoginpublishedEvent triggered when a login prompt is shown.
OnCloseErrorpublished

Inherited

From TComponent (74)

_AddRef _Release BeforeDestruction CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle Create DefineProperties DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetChildren GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetParentComponent GetTypeInfo GetTypeInfoCount HasParent iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name Notification ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReadState ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetName SetParentComponent SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (5)

Assign AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (37)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.