Methods for DataSet
View method list in hierarchical order.
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Add_Client_File | Procedure | Adds a table to this object's related-child list (obsolete) | BaseData_Set |
| Add_Server_File | Procedure | Adds a table to this object's related-parent list (obsolete) | BaseData_Set |
| Add_User_Interface | Procedure | Adds the passed in hoDEO to the list of data entry objects (DEOs) for this object Adds specified hoDEO to the set of DEOs attached to this object. | BaseData_Set |
| Attach_Server | Procedure | Use DDO_Server instead Obsolete Use DDO_Server instead. | BaseData_Set |
| AutoIncrement | Procedure | Handles incrementing of auto-increment columns | BaseData_Set |
| ChildByIndex | Function | Can be used to iterate the direct children of an object ChildByIndex is a function that can be used to iterate the direct children of an object. | cObject |
| ClassSuperClass | Function | Returns the superclass of the passed class This returns the superclass of the passed class. | cObject |
| Clear | Procedure | Clears all tables owned by this object | BaseData_Set |
| Clear_All | Procedure | Clears all files owned by this object and all connected server DataDictionary objects (DDOs) Clear_All sends Refresh to notify data entry objects (DEOs). | BaseData_Set |
| ClearDDRelates | Procedure | Clears all local DD relationships Clears all local Data Dictionary (DD) relationships allowing you to start with a blank slate. | BaseData_Set |
| ClearForTable | Procedure | Clears all tables owned by this object by redirecting Clear to the table's owner | BaseData_Set |
| Constrain | Procedure | Defines constraint set for this object The Constrain procedure defines constraint set for this object, using Constrain_File. | BaseData_Set |
| Create | Function | Creates an object based on the passed Class Id The Create function is used to dynamically create objects. | cObject |
| CreateNamed | Function | Creates an object based on the passed Class Id and assigns it a name Name based on a passed name Creates an object based on the passed Class Id and assigns it a name Name based on a passed name. | cObject |
| CurrentRowId | Function | Returns the RowId of the current record | BaseData_Set |
| Data_Set_PostFind | Procedure | Hook after a find to allow application or removal of Data Dictionary SQL filters | BaseData_Set |
| Data_Set_PreFind | Procedure | Hook prior to a find to allow application or removal of Data Dictionary SQL filters | BaseData_Set |
| Destroy | Procedure | Destroys the object that receives the message and any child objects of that object The Destroy message destroys the object that receives the message. | cObject |
| Detach_Server | Procedure | Disconnects this object and the specified DataDictionary object (DDO), where this object was the client of that DDO server | BaseData_Set |
| Establish_Find_Direction | Procedure | Initializes the constrained find commands to perform searches using the given parameters | BaseData_Set |
| Exit_Application | Procedure | Starts the process of closing an application The Exit_Application message is used to close the program. | cObject |
| Find_By_Recnum | Procedure | Finds record in specified table with record number equal to the passed in record number ### Obsolete This method is obsolete as it can only be used with tables that support recnum. | BaseData_Set |
| FindByRowId | Procedure | Finds record in specified table with record identity equal to the passed RowId and updates the DDO structure | BaseData_Set |
| FindByRowIdEx | Function | Finds record in specified table with record identity equal to the passed RowId and updates the DDO structure, with silent find errors and returning success or failure | BaseData_Set |
| HasRecord | Function | Determines if the DataDictionary object (DDO) has a current record | BaseData_Set |
| IsCascadeDeleteAllowed | Function | Determines whether a child record can be deleted When a delete operation has found a child record, it will see if it can be deleted by calling IsCascadeDeleteAllowed. | BaseData_Set |
| IsClassOfClass | Function | Determines whether the target class is part of the searched class's hierarchy | cObject |
| IsNullParentAllowed | Function | Called to determine if an inactive parent DDO can be null | BaseData_Set |
| IsObjectOfClass | Function | Determines whether the passed class is part of the object's class hierarchy This returns True if the passed class is part of the object's class hierarchy. | cObject |
| IsRelatesToConstrained | Function | Determines if a child DDO is currently constrained to a particular parent table | BaseData_Set |
| Locate_Next | Procedure | Finds the next logical record using the passed in find mode, file, and index specified in a prior Establish_Find_Direction invocation | BaseData_Set |
| ObjectClass | Function | Returns the integer class ID assigned to the class this object is based on Returns the integer class ID assigned to the class this object is based on. | cObject |
| Operation_Not_Allowed | Procedure | Executes the error command with the passed in error number. | BaseData_Set |
| ParentDDOSwitched | Function | Determines whether the parent DDO has switched to a different record Determines whether the parent DDO has switched to a different record. | BaseData_Set |
| Read_By_Recnum | Procedure | Finds record in specified tabile with record number equal to the passed in record number ### Obsolete This method is obsolete as it can only be used with tables that support recnum. | BaseData_Set |
| ReadByRowId | Procedure | Finds record in specified table with record identity equal to the passed RowId without updating or altering the DDO structure | BaseData_Set |
| ReadByRowIdEx | Function | Finds record in specified table with record identity equal to the passed RowId without updating or altering the DDO structure, with silent find errors and returning success or failure | BaseData_Set |
| Rebuild_Constraints | Procedure | Builds the constraint set for a DDO The Rebuild_Constraints procedure builds the constraint set for a DDO. | BaseData_Set |
| RebuildAllConstraints | Procedure | Can be sent to any DDO within a DDO structure to rebuild all constraint within the structure | BaseData_Set |
| Refind_Records | Procedure | Checks to see if the record in the global table buffer is the same as the record in the DDO buffer and refinds the record in the global table buffer if needed | BaseData_Set |
| Remove_Client_File | Procedure | Removes a table from this object's container-file list The Remove_Client_File procedure removes a table from this object's container-table list. | BaseData_Set |
| Remove_Server_File | Procedure | Removes a table from this object's server-file list The Remove_Server_File procedure removes a table from this object's server-table list. | BaseData_Set |
| Remove_User_Interface | Procedure | Removes a table from this object's data entry object (DEO)-list The Remove_User_Interface procedure removes a data entry object (DEO)-id from this object's DEO-list. | BaseData_Set |
| Request_Assign | Procedure | Causes the Refresh message to be sent to all data entry objects for this object and its client and server DataDictionary objects as appropriate | BaseData_Set |
| Request_Clear_File | Procedure | Performs the Clear command on the specified table of the data-server structure The Request_Clear_File procedure performs the Clear command on the specified table of the data-server structure. | BaseData_Set |
| Request_Delete | Procedure | Responsible for deleting a record in the DDO for the main_file, updating all parent DDOs (and tables) and possibly deleting all child records | BaseData_Set |
| Request_Destroy_Object | Procedure | Use the Destroy method instead This method is used to destroy an object and all of its children. | cObject |
| Request_Entry_Update | Procedure | Sends entry_update to all DEOs of the data set and DEOs of servers of the data set as required to store changes to record buffers | BaseData_Set |
| Request_Find | Procedure | Finds on specified table using given find mode and index The Request_Find procedure finds on specified table using given find mode and index. | BaseData_Set |
| Request_Read | Procedure | Finds on specified table using given find mode and index The Request_Read procedure finds on specified table using given find mode and index. | BaseData_Set |
| Request_Relate | Procedure | Performs a relate on the specified table without initializing the done-array The Request_Relate procedure performs a relate on the specified table without initializing the done-array. | BaseData_Set |
| Request_Save | Procedure | Saves all changes in DEOs attached to this object or to any DDO that is a server of this object directly or indirectly | BaseData_Set |
| Request_Superfind | Procedure | Performs superfind on the designated table by the Main_Index of the designated field and notifies all connected DataDictionary objects (DDOs) of the result | BaseData_Set |
| Request_Validate | Function | Request_Validate sends validation messages to all DDO Field's that will participate in the upcoming save Request_Validate returns 0 (zero) if all items are valid, else returns a non-zero value. | BaseData_Set |
| Validate_Constraints | Function | Validates this object's constraints against the record buffer's current content | BaseData_Set |