FireDAC.Comp.Client.TFDCustomManager Methods

From RAD Studio API Documentation
Jump to: navigation, search


InheritedProtected
_AddRefprotectedCalled when an application uses a component interface.
_ReleaseprotectedCalled when an application releases a component interface.
AcquireConnectionpublic
AddConnectionDefpublicAdds the private connection definition.
AfterConstructionpublicResponds after the last constructor has executed.
AfterReuseprotected
AssignpublicCopies the contents of another similar object.
AssignToprotectedCopies the properties of an object to a destination object.
AsyncScheduleprotectedSchedules asynch method calls.
BeforeDestructionpublicPerforms any necessary actions before the first destructor is called.
BeforeReuseprotected
BeginInvokepublicPerforms an asynchronous call to the method specified by either AProc or AFunc.
CanObserveprotectedChecks if a component can be observed by a particular observer.
ChangeNameprotectedSets the private, internal storage for the Name property to the string passed in NewName.
CheckActiveprotected
CheckDisposedprotectedThis method is deprecated.
CheckInactiveprotected
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.
ClosepublicTerminates the FireDAC manager.
CloseConnectionDefpublicCloses the connections for a specified connection definition name.
Createpublic
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.
DeleteConnectionDefpublicDeletes the connection definition.
Destroypublic
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.
DisposeOf (deprecated)publicDisposeOf forces the execution of the destructor code in an object.
DoAfterShutdownprotected
DoAfterStartupprotected
DoBeforeShutdownprotected
DoBeforeStartupprotected
DropConnectionspublicCloses all the connections that are not used.
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.
ExecuteActionpublicExecutes an action.
FieldAddresspublicReturns the address of a published object field.
FindComponentpublicIndicates whether a given component is owned by the component.
FindConnectionpublicFinds the TFDCustomConnection instance with its ConnectionName equal to AConnectionName.
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.
GetBaseDriverDescpublic
GetBaseDriverIDpublicReturns the ID of a base driver for the specified driver ID.
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.
GetConnectionDefNamespublicFills the list with the existing connection definition names.
GetConnectionDefParamspublicFills the list with the connection definition parameters.
GetConnectionDefStatpublic
GetConnectionNamespublicFills the list with connection names.
GetDeltaStreamsprotectedRetrieves a list of streams representing the differences (deltas) between the current state of a component and a previously saved state.
GetDisposedprotectedGetter for the Disposed property.
GetDriverNamespublicFills the list with registered driver IDs.
GetEnumeratorpublicReturns a TComponent enumerator.
GetFieldNamespublicPopulates a string list with the names of the fields in a table.
GetGeneratorNamespublicPopulates a string list with the names of generators / sequences / <how else> 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.
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 key fields in a table.
GetNameprotected
GetNamePathpublicReturns a string used by the Object Inspector.
GetObserversprotectedGetter of Observers.
GetOwnerprotectedReturns the owner of a component.
GetPackageNamespublicPopulates a string list with the names of the packages in a DB.
GetParentprotected
GetParentComponentpublicReturns the containing component.
GetRDBMSKindpublicReturns a DBMS kind for the specified driver ID.
GetSchemaNamespublicPopulates a string list with the names of schemas in a DB.
GetStoredProcNamespublicPopulates a string list with the names of 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.
InternalAcquireConnectionprotected
InternalAcquireTemporaryConnectionprotected
InternalCloseprotected
InternalFindConnectionprotected
InternalOpenprotected
InternalReleaseConnectionprotected
InvokeprotectedProvides access to Automation properties and methods when the component wraps an Automation object.
IsConnectionDefpublicChecks if the given name is the connection definition name.
IsImplementorOfpublicIndicates whether the component implements a specified interface.
LoadConnectionDefFilepublicLoads the file containing the connection definitions.
Loadedprotected
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
ModifyConnectionDefpublicModifies the parameters of an existing connection definition.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
NotificationprotectedForwards notification messages to all owned components.
ObserverAddedprotectedAllows the component to handle the addition of an observer.
OpenpublicActivates the FireDAC manager.
operator ()public
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.
RefreshConnectionDefFilepublicRefreshes the list with the connection definitions.
RefreshMetadataCachepublicInvalidates the metadata cache for all connections.
ReleaseConnectionpublic
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.
RenameConnectionDefpublicRenames the existing AOldName FireDAC connection definition to ANewName.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SaveConnectionDefFilepublicSaves the connection definitions to a file.
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.
SetOwnerprotected
SetParentComponentprotectedSets the parent component.
SetSubComponentpublicIdentifies whether the component is a subcomponent.
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.