Data.SqlExpr.TSQLDataSet 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.
AfterConstructionpublicResponds after the last constructor has executed.
AllocRecordBufferprotectedAllocates memory for the record buffer.
AppendpublicAdds a new, empty record to the end of the dataset.
AppendRecordpublicAdds a new, populated record to the end of the dataset and posts it.
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.
BookmarkValidpublicIndicates the validity of a specified bookmark.
CalculateFields (deprecated)protectedCalculates the lookup fields.
CancelpublicCancels modifications to the active record if those changes are not yet posted.
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.
ClearCalcFields (deprecated)protectedClears the lookup and calculated fields.
ClearFieldspublicClears the contents of all fields for the active record.
ClosepublicCloses a dataset.
CloseBlobprotectedCloses a binary large object field.
CompareBookmarkspublicImplements a virtual function to compare two bookmarks.
ControlsDisabledpublicIndicates whether data-aware controls update their display to reflect changes to the dataset.
CopyFieldspublicCopyFields copies the field definition structure of another dataset.
CreatepublicCreates an instance of a TSQLDataSet component.
CreateBlobStreampublicCreates a blob stream for a Binary large object (BLOB) field in the dataset.
CreateFieldsprotectedCreates the automatic fields.
CreateNestedDataSetprotectedCreates a nested dataset.
CursorPosChangedpublicMarks the internal cursor position as invalid.
DataConvert (deprecated)protectedConverts the data depending on the field type.
DataEventprotectedNotifies the attached dataset about a specific event.
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.
DefChangedprotectedEvent handler that updates the field definition.
DeletepublicDeletes the active record and positions the dataset on the next record.
DestroyComponentspublicDestroys all owned components.
DestroyFieldsprotectedDestroys the dataset automatic fields.
DestroyingpublicIndicates that the component and its owned components are about to be destroyed.
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.
DoBeforeInsertprotectedBeforeInsert event dispatcher.
DoBeforeOpenprotectedBeforeOpen event dispatcher.
DoBeforePostprotectedBeforePost event dispatcher.
DoBeforeRefreshprotectedBeforeRefresh event dispatcher.
DoBeforeScrollprotectedBeforeScroll event dispatcher.
DoOnCalcFieldsprotectedOnCalcFields event dispatcher.
DoOnNewRecordprotectedOnNewRecord event dispatcher.
EditpublicEnables editing of data in the dataset.
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.
ExecSQLpublicExecutes a query or stored procedure that does not return a set of records.
ExecuteActionpublicExecutes an action.
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.
FindLastpublicImplements a virtual method for positioning the dataset on the last record, respecting any filters.
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.
FindRecordprotectedImplements a virtual method for positioning the dataset on a specific 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.
FreeRecordBufferprotectedFrees the record buffer.
GetAggFieldsClassprotectedReturns the metaclass for the aggregate fields.
GetAggRecordCountprotectedReturns the number of aggregate fields.
GetAggregateValueprotectedReturns the value for an aggregate field.
GetBlobFieldDatapublicRetrieves the current value of a BLOB field into a buffer.
GetBookmarkpublicAllocates a bookmark for the active record in the dataset.
GetBookmarkData (deprecated)protectedGets the bookmark for the record buffer given by the parameter.
GetBookmarkFlag (deprecated)protectedGets the bookmark flag for the record buffer given by the parameter.
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.
GetClonedDataSetpublicCreates a new instance of the TDataSet derived class and clones the structure and data of this dataset to the new instance.
GetCurrentRecord (deprecated)publicImplements a virtual function to retrieve the current record in a buffer.
GetDetailDataSets (deprecated)publicFills a list with a dataset for every detail dataset that is not the value of a nested dataset field.
GetDetailLinkFields (deprecated)publicLists the field components that link this dataset as a detail of a master dataset.
GetDisposedprotectedGetter for the Disposed property.
GetEnumeratorpublicReturns a TComponent enumerator.
GetFieldClassprotectedReturns the metaclass for a field class.
GetFieldData (deprecated)publicRetrieves the current value of a field into a buffer.
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.
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.
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.
GetIsIndexFieldprotectedChecks whether the given field is an index field.
GetKeyFieldNamespublicFills a list with the names of all fields in all indexes defined for the dataset.
GetLookupListClassprotectedReturns the metaclass for a lookup field list class.
GetNamePathpublicReturns a string used by the Object Inspector.
GetNextRecordprotectedMoves to the next record.
GetNextRecordsprotectedMoves to the last record of the dataset.
GetObserversprotectedGetter of Observers.
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.
GetQuoteCharpublicReturns the character or characters to use in generated SQL statements to enclose quoted strings.
GetRecNoprotectedReturns the position of the active record in the dataset. GetRecNo is a getter method for the RecNo property.
GetRecord (deprecated)protected
GetRecordSizeprotectedReturns the size of a record in the dataset.
GetStateFieldValueprotectedReturns a Field as a Variant.
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.
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.
InitRecord (deprecated)protected
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.
InternalAddRecord (deprecated)protectedAdds a record to the dataset.
InternalCancelprotectedCancels the modification made to the current record of the dataset.
InternalDeleteprotectedUsed internally to delete the current record.
InternalEditprotectedUsed to edit the current record from the dataset.
InternalFirstprotectedMoves to a position "before" the first record of the dataset.
InternalGotoBookmark (deprecated)protectedMoves to the record with the given bookmark.
InternalInitRecord (deprecated)protectedInitializes a record buffer.
InternalInsertprotectedUsed to insert an empty record in the dataset.
InternalLastprotectedMoves to a position "after" the last record of the dataset.
InternalPostprotectedUsed to post data in the dataset.
InternalSetToRecord (deprecated)protectedMoves to the record with the given record buffer.
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 dataset can use record numbers to indicate the order of records.
LastpublicMoves to the last record in the dataset.
LocatepublicImplements a virtual method for searching a dataset for a specified record and making it the active record.
LocateRecordprotectedImplements a virtual method for searching a dataset for a specified record and making it the active record.
LookuppublicImplements a virtual method to retrieve field values from a record that matches specified search 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.
NotificationprotectedForwards notification messages to all owned components.
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.
ParamByNamepublicLocates a parameter in the Params property collection.
PostpublicImplements a virtual method to write a modified record to the database or change log.
PrepareStatementpublicPerforms a prepare on the SQL statement.
PriorpublicMoves to the previous record in the dataset.
PSExecuteStatement (deprecated)protected
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.
RefreshpublicRe-fetches data from the database to update a dataset's view of data.
RefreshInternalCalcFields (deprecated)protectedRefreshes the calculated fields.
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.
ResetAggFieldprotectedResets the aggregate field.
RestoreStateprotectedRestores the operating mode of the dataset to the given value.
ResyncpublicRe-fetches the active record and the records that precede and follow it.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SetActiveprotectedChanges the dataset's state to active.
SetAncestorprotectedClears or sets csAncestor state in the component's ComponentState property.
SetBlockReadSizeprotectedSetter method for BlockReadSize.
SetBookmarkData (deprecated)protectedSets the bookmark for the record buffer given by the parameter.
SetBookmarkFlag (deprecated)protectedSets the bookmark flag for the record buffer given by the parameter.
SetBookmarkStr (deprecated)protectedSets a bookmark represented as a string.
SetChildOrderprotectedSets the visual ordering of a child dataset.
SetCurrentRecordprotectedMoves to the record given by the index.
SetDataSetFieldprotectedSets the persistent TDataSetField object that owns a nested dataset.
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.
SetFieldData (deprecated)protected
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
SetFilteredprotectedSetter method for Filtered.
SetFilterOptionsprotectedSetter method for FilterOptions.
SetFilterTextprotectedSetter method for Filter.
SetFoundprotectedSets a "found" flag.
SetInlineprotectedSets the csInline bit of the component's ComponentState property.
SetModifiedprotectedUsed internally to set the Modified property.
SetObjectViewprotectedSets the ObjectView property.
SetOnFilterRecordprotectedOnFilterRecord event setter method.
SetParentComponentprotectedSets the parent component.
SetRecNoprotectedSets the active record in the dataset.
SetSchemaInfopublicIndicates whether the dataset represents metadata from the server, and if so, what kind.
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.
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 active record.
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.