Datasnap.DBClient.TCustomClientDataSet Methods

From RAD Studio API Documentation
Jump to: navigation, search

_AddRefprotectedCalled when an application uses a component interface.
_ReleaseprotectedCalled when an application releases a component interface.
ActivateBuffersprotectedActivates the buffers for the active record.
ActiveBufferpublicReturns a pointer to the buffer for the active record.
AddIndexpublicCreates a new index for the client dataset.
AfterConstructionpublicResponds after the last constructor has executed.
AppendpublicAdds a new, empty record to the end of the dataset.
AppendDatapublicAdds a newly fetched packet of records to those already stored in the client dataset.
AppendRecordpublicAdds a new, populated record to the end of the dataset and posts it.
ApplyRangepublicApplies a range to the dataset.
ApplyUpdatespublicSends all updated, inserted, and deleted records from the client dataset to the provider for writing to the database.
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.
BindFieldsprotectedBinds the TField components to the physical fields.
BlockReadNextprotectedMoves to the record from the next block and reads it.
BookmarkAvailableprotectedVerifies whether there is a bookmark available.
BookmarkValidpublicTests the validity of a specified bookmark.
CalculateFields (deprecated)protectedCalculates the lookup fields.
CancelpublicCancels unposted changes to the current record.
CancelRangepublicRemoves any ranges currently in effect for the client dataset.
CancelUpdatespublicClears all pending edits and clears the change log.
ChangeNameprotectedSets the private, internal storage for the Name property to the string passed in NewName.
CheckActiveprotectedChecks whether the dataset is active.
CheckBiDirectionalprotectedChecks whether the dataset is bidirectional.
CheckBrowseModepublicAutomatically posts or cancels data changes when the active record changes.
CheckFieldCompatibilityprotectedChecks the compatibility of a field.
CheckInactiveprotectedChecks whether the dataset is inactive.
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.
ClearBuffersprotectedClears the buffers for the active record.
ClearFieldspublicClears the contents of all fields for the active record.
CloneCursorpublicShares the data belonging to another client dataset.
ClosepublicCloses a dataset.
CloseBlobprotectedCloses a binary large object field.
CompareBookmarkspublicCompares two bookmarks.
ConstraintsDisabledpublicIndicates whether constraints are enabled for a client dataset.
ControlsDisabledpublicIndicates whether data-aware controls update their display to reflect changes to the dataset.
CopyFieldspublicCopyFields copies the field definition structure of another dataset.
CreatepublicCreates and initializes an instance of TCustomClientDataSet.
CreateBlobStreampublicReturns a TClientBlobStream object for reading or writing the data in a specified blob field.
CreateDataSetpublicCreates a new, empty client dataset.
CreateFieldsprotectedCreates the automatic fields.
CreateNestedDataSetprotectedCreates a nested dataset.
CursorPosChangedpublicMarks the internal cursor position as invalid.
DataRequestpublicGenerates an OnDataRequest event on the associated provider.
DefaultFields (deprecated)publicIndicates whether a dataset's underlying field components are generated dynamically when the dataset is opened.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DeletepublicDeletes the active record and positions the dataset on the next record.
DeleteIndexpublicDeletes an index for the client dataset.
DestroypublicDestroys the instance of a client dataset component.
DestroyComponentspublicDestroys all owned components.
DestroyFieldsprotectedDestroys the dataset automatic fields.
DestroyingpublicIndicates that the component and its owned components are about to be destroyed.
DisableConstraintspublicDisables the enforcement of constraints.
DisableControlspublicDisables data display in data-aware controls associated with the dataset.
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.
DoAfterCancelprotectedAfterCancel event dispatcher.
DoAfterCloseprotectedAfterClose event dispatcher.
DoAfterDeleteprotectedAfterDelete event dispatcher.
DoAfterEditprotectedAfterEdit event dispatcher.
DoAfterInsertprotectedAfterInsert event dispatcher.
DoAfterOpenprotectedAfterOpen event dispatcher.
DoAfterPostprotectedAfterPost event dispatcher.
DoAfterRefreshprotectedAfterRefresh event dispatcher.
DoAfterScrollprotectedAfterScroll event dispatcher.
DoBeforeCancelprotectedBeforeCancel event dispatcher.
DoBeforeCloseprotectedBeforeClose event dispatcher.
DoBeforeDeleteprotectedBeforeDelete event dispatcher.
DoBeforeEditprotectedBeforeEdit event dispatcher.
DoBeforeOpenprotectedBeforeOpen event dispatcher.
DoBeforePostprotectedBeforePost event dispatcher.
DoBeforeRefreshprotectedBeforeRefresh event dispatcher.
DoBeforeScrollprotectedBeforeScroll event dispatcher.
DoOnCalcFieldsprotectedOnCalcFields event dispatcher.
EditpublicEnables editing of data in the dataset.
EditKeypublicEnables modification of the search key buffer.
EditRangeEndpublicEnables changing the ending value for an existing range.
EditRangeStartpublicEnables changing the starting value for an existing range.
EmptyDataSetpublicRemoves all records from the dataset.
EnableConstraintspublicReenables enforcement of constraints when records are posted.
EnableControlspublicRe-enables data display in data-aware controls associated with the dataset.
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 an SQL command by the provider's dataset.
ExecuteActionpublicExecutes an action.
ExecuteCommandprotectedExecutes an extended command of a TDataSet descendant.
FetchBlobspublicRetrieves BLOB field values from the provider.
FetchDetailspublicRetrieves nested detail datasets from the provider.
FetchParamspublicRetrieves parameter values from the provider.
FieldAddresspublicReturns the address of a published object field.
FieldByNamepublicFinds a field based on its name.
FieldByNumberprotectedFinds a field based on the ordinal position of its column in the underlying table or query.
FindComponentpublicIndicates whether a given component is owned by the component.
FindFieldpublicSearches for a specified field in the dataset.
FindFirstpublicImplements a virtual method for positioning the dataset on the first record, respecting any filters.
FindKeypublicSearches for a record containing specified field values.
FindLastpublicImplements a virtual method for positioning the dataset on the last record, respecting any filters.
FindNearestpublicMoves the cursor to the record that most closely matches a specified set of key values.
FindNextpublicImplements a virtual method for positioning the dataset on the next record, respecting any filters.
FindPriorpublicImplements a virtual method for positioning the dataset on the previous record, respecting any filters.
FirstpublicMoves to the first record in the dataset.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeBookmarkpublicFrees the resources allocated for a specified bookmark (somewhat obsolete).
FreeFieldBuffersprotectedFrees the field buffers.
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.
GetAggFieldsClassprotectedReturns the metaclass for the aggregate fields.
GetAggRecordCountprotectedReturns the number of aggregate fields.
GetBlobFieldDatapublicReads BLOB data into a buffer.
GetBookmarkpublicAllocates a bookmark for the active record in the dataset.
GetBookmarkStr (deprecated)protectedGets a bookmark represented as a string.
GetCalcFields (deprecated)protectedComputes the lookup and calculated fields and updates the status.
GetCheckConstraintsClassprotectedReturns the metaclass for TCheckConstraints.
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 the owned datasets that are also owned by the specified TComponent.
GetCommandStatesprotectedChecks whether an extended command is supported and enabled or not.
GetCurrentRecordpublicRetrieves the current record into a buffer.
GetDetailDataSets (deprecated)publicFills a list with a dataset for every detail dataset that is not the value of a nested dataset field.
GetDisposedprotectedGetter for the Disposed property.
GetEnumeratorpublicReturns a TComponent enumerator.
GetFieldClassprotectedReturns the metaclass for a field class.
GetFieldDatapublicRetrieves the current value of a field.
GetFieldDefListClassprotectedReturns the metaclass for a field definition list class.
GetFieldDefsClassprotectedReturns the metaclass of the TFieldDefs class.
GetFieldFullNameprotectedReturns the full name of the field.
GetFieldList (deprecated)publicRetrieves a specified set of field objects into a list.
GetFieldListClassprotectedReturns the metaclass for a field list class.
GetFieldNamespublicRetrieves a list of names for all fields in a dataset.
GetFieldsClassprotectedReturns the TFields descendant metaclass.
GetGroupStatepublicIndicates where the current record sits within a specified group of records.
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).
GetIndexDefsprotectedReturns the definitions of all specified indexes defined for the dataset.
GetIndexDefsClassprotectedReturns the metaclass for an index definition list.
GetIndexInfopublicRetrieves information about the current index.
GetIndexNamespublicRetrieves a list of available indexes for a client dataset.
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.
GetLookupListClassprotectedReturns the metaclass for a lookup field list class.
GetNamePathpublicReturns a string used by the Object Inspector.
GetNextPacketpublicRetrieves the next block of records from the provider.
GetNextRecordprotectedMoves to the next record.
GetNextRecordsprotectedMoves to the last record of the dataset.
GetObserversprotectedGetter of Observers.
GetOptionalParampublicRetrieves a custom parameter from the data packet.
GetOwnerprotectedReturns the owner of a component.
GetParamsClassprotectedReturns the metaclass for a list of field parameters.
GetParentComponentpublicReturns the containing component.
GetPriorRecordprotectedMoves to the prior record.
GetPriorRecordsprotectedMoves to the first record of the dataset.
GetTypeInfoprotectedRetrieves the type information for an object.
GetTypeInfoCountprotectedReturns the number of type information interfaces that an object provides (either 0 or 1).
GotoBookmarkpublicImplements a virtual method to position the dataset on the record to which a specified bookmark points.
GotoCurrentpublicSets the current record in this dataset the same as the current record in another, cloned dataset.
GotoKeypublicMoves the cursor to a record specified by the current key.
GotoNearestpublicMoves the cursor to the record that most closely matches the current key.
HasParentpublicVerifies whether the component has a parent.
InheritsFrompublicDetermines the relationship of two object types.
InitFieldDefsprotectedInitializes the field definitions.
InitFieldDefsFromFieldsprotectedInitializes the field definitions from persistent fields.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InsertpublicInserts a new, empty record in the dataset.
InsertComponentpublicEstablishes the component as the owner of a specified component.
InsertRecordpublicInserts a new, populated record to the dataset and posts it.
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.
IsEmptypublicIndicates whether the dataset contains no records.
IsImplementorOfpublicIndicates whether the component implements a specified interface.
IsLinkedTopublicIndicates whether a dataset is linked to a specified data source.
IsSequencedpublicIndicates whether the underlying database table uses record numbers to indicate the order of records.
LastpublicMoves to the last record in the dataset.
LoadFromFilepublicLoads a client dataset's data from a file.
LoadFromStreampublicLoads a client dataset's data from a stream.
LocatepublicSearches the dataset for a specified record and makes that record current.
LocateRecordprotectedSearches the dataset for a specified record.
LookuppublicRetrieves field values from a record that matches specified search values.
MergeChangeLogpublicMerges any data changes in the change log into the client dataset, overwriting existing values.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
MoveBypublicMoves to another record relative to the active record in the dataset.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
NextpublicMoves to the next record in the dataset.
OpenpublicOpens the dataset.
OpenCursorCompleteprotectedOpens the database cursor and triggers an AfterOpen event.
OpenParentDataSetprotectedOpens the parent dataset.
operator []public
operator ()public
PaletteCreatedprotectedResponds when the component is created from the component palette.
PostpublicWrites a modified record to the Data property or the change log.
PriorpublicMoves to the previous record in the dataset.
PSEndTransactionprotectedEnds a transaction that was started by a call to PSStartTransaction.
PSExecuteprotectedExecutes the SQL command associated with the dataset.
PSExecuteStatement (deprecated)protectedExecutes a specified SQL command.
PSGetAttributesprotectedReturns information that is stored in data packets as Name/Value pairs.
PSGetDefaultOrderprotectedReturns the definition of an index that imposes the default order on the data included in data packets.
PSGetKeyFieldsprotectedReturns the names of all fields required to uniquely identify records in the data packet.
PSGetParamsprotectedReturns the current parameter values of the dataset.
PSGetQuoteCharprotectedReturns the character or characters to use in generated SQL statements to enclose quoted strings.
PSGetTableNameprotectedReturns the name of the dataset table that appears in generated SQL statements.
PSGetUpdateExceptionprotectedGenerates an EUpdateError object based on another exception object.
PSInTransactionprotectedIndicates whether actions against the dataset occur in the context of a transaction.
PSIsSQLBasedprotectedIndicates whether the dataset includes native SQL support.
PSIsSQLSupportedprotectedIndicates whether the dataset can execute SQL statements.
PSResetprotectedResets the dataset so that it is positioned on the first record.
PSSetCommandTextprotectedAssigns a specified SQL command to be executed by PSExecute.
PSSetParamsprotectedAssigns the specified parameter values to the dataset.
PSStartTransactionprotectedStarts a transaction that encapsulates all activity until a call to PSEndTransaction.
PSUpdateRecordprotectedApplies a single update to the underlying database table or tables.
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.
ReconcilepublicClears successfully updated records from the client dataset's cache of changes.
ReferenceInterfacepublicEstablishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
RefreshpublicRe-fetches data from the database to update a dataset's view of data.
RefreshRecordpublicUpdates the base values of the current record to match the current values of the provider's dataset.
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.
RestoreStateprotectedRestores the operating mode of the dataset to the given value.
ResyncpublicRe-fetches the active record and the records that precede and follow it.
RevertRecordpublicUndoes edits to the current record.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SaveToFilepublicSaves a client dataset's data to an external file.
SaveToStreampublicSaves a client dataset's data to a stream.
SetActiveprotectedChanges the dataset's state to active.
SetAltRecBuffersprotectedSets record buffers when accessing field values.
SetAncestorprotectedClears or sets csAncestor state in the component's ComponentState property.
SetBlockReadSizeprotectedSetter method for BlockReadSize.
SetBookmarkStr (deprecated)protectedSets a bookmark represented as a string.
SetBufListSizeprotectedSets the size of the buffer list.
SetChildOrderprotectedSets the visual ordering of a child dataset.
SetCurrentRecordprotectedMoves to the record given by the index.
SetDefaultFields (deprecated)protectedSpecifies whether a dataset's underlying field components are generated dynamically when the dataset is opened.
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.
SetFieldDefPropsprotectedSets the properties of the specified FieldDef from the Field parameter.
SetFieldPropsprotectedSets the properties of the specified Field from the FieldDef parameter.
SetFieldspublicSets the values for all fields in a record
SetFoundprotectedSets a "found" flag.
SetInlineprotectedSets the csInline bit of the component's ComponentState property.
SetKeypublicEnables setting of keys and ranges for a dataset prior to a search.
SetModifiedprotectedUsed internally to set the Modified property.
SetObjectViewprotectedSets the ObjectView property.
SetOptionalParampublicSaves a custom parameter with the data packet.
SetParentComponentprotectedSets the parent component.
SetProviderpublicAssociates the client dataset with a provider in the same process space.
SetRangepublicSets the starting and ending values of a range, and applies it.
SetRangeEndpublicIndicates that subsequent assignments to field values specify the end of the range of rows to include in the dataset.
SetRangeStartpublicIndicates that subsequent assignments to field values specify the start of the range of rows to include in the dataset.
SetStateprotectedSets the dataset's state.
SetStateFieldValueprotectedSets a Field to a Value.
SetSubComponentpublicIdentifies whether the component is a subcomponent.
SetTempStateprotectedRestores the operating mode of the dataset to the given value.
SetUniDirectionalprotectedSets the dataset type: unidirectional or not.
TempBufferprotectedReturns a temporary buffer.
ToStringpublicReturns a string containing the class name.
TranslatepublicImplements a virtual procedure to copy a data string from a source to a destination, optionally performing character translation during the copy.
UndoLastChangepublicUndoes the last edit, insert, or delete operation to a record in the client dataset.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UpdateActionpublicUpdates the state of an action.
UpdateBufferCountprotectedUpdates the buffer count.
UpdateCursorPospublicPositions the cursor on the active record.
UpdatedprotectedClears the csUpdating state in the component's ComponentState property when the component finishes updating.
UpdateRecordpublicEnsures that data-aware controls and detail datasets reflect record updates.
UpdateRegistryprotectedProvides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdateStatuspublicReports the update status for the current record in the dataset.
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.