Datasnap.Provider.TDataSetProvider 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.
AfterConstructionpublicResponds after the last constructor has executed.
ApplyUpdatespublicApplies updates received as a delta packet.
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.
BeginInvokepublicPerforms an asynchronous call to the method specified by either AProc or AFunc.
CanObserveprotected
ChangeNameprotectedSets the private, internal storage for the Name property to the string passed in NewName.
CheckDataSetprotectedVerifies whether the dataset is assigned.
CheckDisposedprotected
CheckResolverprotectedInstantiates a resolver for the Resolver property if it does not already exist.
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.
CreatepublicCreates and initializes a TDataSetProvider object.
CreateDataPacketprotectedGenerates a data packet for the data associated with the provider.
CreateResolverprotectedCreates a resolver component for handling the application of updates.
DataRequestpublicGenerates an OnDataRequest event.
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.
DestroypublicFrees an instance of a dataset provider.
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.
DoAfterApplyUpdatesprotectedGenerates an AfterApplyUpdates event.
DoAfterExecuteprotectedGenerates an AfterExecute event.
DoAfterGetParamsprotectedGenerates an AfterGetParams event.
DoAfterGetRecordsprotectedGenerates an AfterGetRecords event.
DoAfterRowRequestprotectedGenerates an AfterRowRequest event.
DoAfterUpdateRecordprotectedGenerates an AfterUpdateRecord event.
DoApplyUpdatesprotected
DoBeforeApplyUpdatesprotectedGenerates a BeforeApplyUpdates event.
DoBeforeCommitprotected
DoBeforeExecuteprotectedGenerates a BeforeExecute event.
DoBeforeGetParamsprotectedGenerates a BeforeGetParams event.
DoBeforeGetRecordsprotectedGenerates a BeforeGetRecords event.
DoBeforeRowRequestprotectedGenerates a BeforeRowRequest event.
DoBeforeUpdateRecordprotected
DoGetProviderAttributesprotectedFills a list with information about the dataset that can be used when providing or resolving.
DoGetRecordsprotected
DoGetTableNameprotectedGenerates an OnGetTableName event.
DoOnGetDataprotectedGenerates an OnGetData event.
DoOnUpdateDataprotectedGenerates an OnUpdateData event.
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.
ExecutepublicExecutes a query, stored procedure, or custom SQL statement.
ExecuteActionpublicExecutes an action.
FetchDetailsprotectedFills a delta dataset with all nested dataset field values.
FieldAddresspublicReturns the address of a published object field.
FindComponentpublicIndicates whether a given component is owned by the component.
FindRecordprotectedFinds a data record.
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.
FreeResolverprotectedFrees the resolver specified by the Resolver property.
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.
GetDataSetFromDeltaprotectedReturns a dataset positioned on the record of the source dataset that is currently being fetched or updated.
GetDeltaStreamsprotected
GetDisposedprotectedGetter for the Disposed property.
GetEnumeratorpublicReturns a TComponent enumerator.
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).
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.
GetNamePathpublicReturns a string used by the Object Inspector.
GetObserversprotectedGetter of Observers.
GetOwnerprotectedReturns the owner of a component.
GetParamspublicReturns the current parameter values.
GetParentComponentpublicReturns the containing component.
GetRecordspublicRetrieves a data packet that represents the provider's associated data.
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.
InternalApplyUpdatesprotectedProvides the underlying implementation of the ApplyUpdates method.
InternalExecuteprotectedProvides the underlying implementation of the Execute method.
InternalGetParamsprotectedReturns the requested parameter values as a Variant array.
InternalGetRecordsprotectedProvides the underlying implementation of the GetRecords method.
InternalRowRequestprotectedProvides the underlying implementation of the RowRequest method.
InvokeprotectedProvides access to Automation properties and methods when the component wraps an Automation object.
IsImplementorOfpublicIndicates whether the component implements a specified interface.
LoadedprotectedInitializes the component after the form file has been read into memory.
LocateRecordprotectedPositions a dataset on the record that corresponds to the current update in a specified delta packet.
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.
NotificationprotectedResponds to notifications that objects are being created or destroyed.
ObserverAddedprotected
operator ()publicC++ conversion of a TComponent into a System.Classes.IInterfaceComponentReference or a System.IInterface, depending on casting.
PaletteCreatedprotectedResponds when the component is created from the component palette.
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.
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.
ResetprotectedResets and closes the dataset.
RowRequestpublicReturns information from a specified record.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SetActiveUpdateExceptionprotected
SetAncestorprotectedClears or sets csAncestor state in the component's ComponentState property.
SetChildOrderprotectedSets the visual ordering of a child control.
SetCommandTextprotectedProvides a way to set the command text.
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.
SetParamsprotectedProvides a way to set the dataset provider's parameters.
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.
UpdateRecordprotectedRetrieves specified data from a source dataset into a delta packet.
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.