FireDAC.Comp.Client.TFDConnection Methods

From Appmethod Libraries
Jump to: navigation, search

_AddRefprotectedCalled when an application uses a component interface.
_ReleaseprotectedCalled when an application releases a component interface.
AbortJobpublicUse the AbortJob method to abort all running dataset operations on this connection.
AfterConstructionpublicResponds after the last constructor has executed.
ApplyUpdates (deprecated)publicApplies change logs of the specified datasets to the DBMS.
AssignpublicAssigns all the properties of one connection to this connection.
AssignToprotectedCopies the properties of an object to a destination object.
AsyncScheduleprotectedSchedules asynch method calls.
BeforeDestructionpublicPerforms any necessary actions before the first destructor is called.
BeginInvokepublicPerforms an asynchronous call to the method specified by either <AProc> or <AFunc>.
ChangeNameprotectedSets the private, internal storage for the Name property to the string passed in NewName.
CheckActivepublicChecks to see whether the connection is active.
CheckConnectionDefpublicChecks whether the connection definition is filled correctly.
CheckInactivepublicChecks to see whether the connection is inactive.
CheckOnlinepublicChecks to see whether the connection is in online mode.
ClassInfopublicReturns a pointer to the run-time type information (RTTI) table for the object type.
ClassNamepublicReturns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIspublicDetermines whether an object is of a specific type.
ClassParentpublicReturns the type of the immediate ancestor of a class.
ClassTypepublicReturns the class reference for the object's class.
CleanupInstancepublicPerforms finalization on long strings, variants, and interface variables within a class.
CloneConnectionpublicCreates a clone of the current connection object and assigns most property values of this connection to the cloned connection object.
ClosepublicCloses the connection.
CommitpublicPermanently stores modifications to the data made in the current transaction, and optionally ends the current transactions.
CommitRetainingpublicPermanently stores the modifications to the data made in the current transaction, without ending the current transaction.
DecodeObjectNamepublicSplits DB object name into parts.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DefinePropertiesprotectedDesignates methods for storing an object's unpublished data on a stream such as a form file.
DestroyComponentspublicDestroys all owned components.
DestroyingpublicIndicates that the component and its owned components are about to be destroyed.
DispatchpublicCalls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOfpublicDisposeOf forces the execution of the destructor code in an object.
EncodeObjectNamepublicAssembles a DB object name from it parts.
EndFunctionInvokepublicBlocks the caller until the specified <ASyncResult> completes.
EndInvokepublicBlocks the caller until the specified <ASyncResult> completes.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
ExecSQLpublicExecutes a SQL command and returns the number of affected rows.
ExecSQLScalarpublicExecutes a SQL command.
ExecuteActionpublicExecutes an action.
FieldAddresspublicReturns the address of a published object field.
FindComponentpublicIndicates whether a given component is owned by the component.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
FreeNotificationpublicEnsures that AComponent is notified that the component is going to be destroyed.
FreeOnReleasepublicFrees the interface reference for components that were created from COM classes.
GetCatalogNamespublicPopulates a string list with the names of catalogs in a DB.
GetChildOwnerprotectedReturns the owner of a child component being read from a stream.
GetChildParentprotectedReturns the parent or, if there is no parent, returns the owner of a child component being read from a stream.
GetChildrenprotectedEnumerates all child components.
GetDataSetprotectedReturns a dataset, given its index in the DataSets property array.
GetDataSetCountprotectedReturns the value of the DataSetCount property.
GetDisposedprotectedGetter for the Disposed property.
GetEnumeratorpublicReturns a TComponent enumerator.
GetFieldNamespublicPopulates a string list with the names of fields in a table.
GetGeneratorNamespublicPopulates a string list with the names of generators, sequences, or others in a database.
GetHashCodepublicReturns an integer containing the hash code.
GetIDsOfNamesprotectedMaps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
GetIndexNamespublicReturns a list of table indexes of the database.
GetInfoReportpublicPopulates a string list with a detailed report about the connection status.
GetInterfacepublicRetrieves a specified interface.
GetInterfaceEntrypublicReturns the entry for a specific interface implemented in a class.
GetInterfaceTablepublicReturns a pointer to a structure containing all of the interfaces implemented by a given class.
GetKeyFieldNamespublicPopulates a string list with the names of the key fields in a table.
GetLastAutoGenValuepublicReturns the last autogenerated value.
GetNamePathpublicReturns a string used by the Object Inspector.
GetOwnerprotectedReturns the owner of a component.
GetPackageNamespublicPopulates a string list with the names of the packages in a DB.
GetParentComponentpublicReturns the containing component.
GetSchemaNamespublicPopulates a string list with the names of schemas in a DB.
GetStoredProcNamespublicPopulates a string list with the names of the stored procedures in a DB.
GetTableNamespublicPopulates a string list with the names of tables in a DB.
GetTypeInfoprotectedRetrieves the type information for an object.
GetTypeInfoCountprotectedReturns the number of type information interfaces that an object provides (either 0 or 1).
HasParentpublicVerifies whether the component has a parent.
InheritsFrompublicDetermines the relationship of two object types.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InsertComponentpublicEstablishes the component as the owner of a specified component.
InstanceSizepublicReturns the size in bytes of each instance of the object type.
InvokeprotectedProvides access to Automation properties and methods when the component wraps an Automation object.
IsImplementorOfpublicIndicates whether the component implements a specified interface.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
OfflinepublicSets the connection to offline mode.
OnlinepublicSets the connection to online mode.
OpenpublicOpens the connection to the database.
operator ()public
PaletteCreatedprotectedResponds when the component is created from the component palette.
PingpublicPings the DBMS server.
QualifiedClassNamepublicReturns the qualified name of the class.
QueryInterfaceprotectedReturns a reference to a specified interface if the current component supports that interface.
ReadStateprotectedReads the state of the component.
ReferenceInterfacepublicEstablishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
RefreshMetadataCachepublicInvalidates the metadata cache.
RegisterClientprotectedRegisters an object that uses the connection component.
ReleaseClientspublicPerforms a resource releasing operation on all associated datasets and commands.
RemoveComponentpublicRemoves a specified component specified from the component's Components list.
RemoveFreeNotificationpublicDisables the destruction notification that was enabled by FreeNotification.
RemoveFreeNotificationsprotectedNotifies all owned components of the owner component's imminent destruction.
RollbackpublicCancels all modifications to the data made in the current transaction and optionally ends the transaction.
RollbackRetainingpublicCancels all modifications to the data made in the current transaction, without ending the current transaction.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SendConnectEventprotectedInforms all registered clients that use the connection component when a connection is opened or closed.
SetAncestorprotectedClears or sets csAncestor state in the component's ComponentState property.
SetChildOrderprotectedSets the visual ordering of a child control.
SetDesigningprotectedEnsures that components inserted at design time have their design-mode flag set.
SetDesignInstanceprotectedEnsures that components inserted at design time have their design-mode flag set.
SetInlineprotectedSets the csInline bit of the component's ComponentState property.
SetNameprotectedSets the value of the Name property.
SetParentComponentprotectedSets the parent component.
SetSubComponentpublicIdentifies whether the component is a subcomponent.
StartTransactionpublicStarts a new database transaction.
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UpdateActionpublicUpdates the state of an action.
UpdatedprotectedClears the csUpdating state in the component's ComponentState property when the component finishes updating.
UpdateRegistryprotectedProvides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdatingprotectedSets the csUpdating state in the component's ComponentState property.
ValidateContainerprotectedDetermines whether an object can be inserted into a container.
ValidateInsertprotectedProvides the interface for a method that validates a child component before it is inserted.
ValidateRenameprotectedEnsures that renaming an owned component does not create a name conflict.
WriteStateprotectedWrites the state of the component.