Methods for DataDictionary

View method list in alphabetical order

NameTypeDescription
Add_Client_FileProcedure SetAdds a table to this object's related-child list
Add_Server_FileProcedure SetAdds a table to this object's related-parent list
Add_System_FileProcedureObsolete Adds iFile to this object's system file list
Add_System_FileProcedure SetAdds a table to this object's system file list
Alias_FileProcedure SetDeclares this DD to be an alias DD
AllowParentFindFunctionCalled to determine if the parent DD can be use to do a parent find
ApplySQLFilterProcedureCalled before a Data Dictionary find/read and is used to set DD SQL Filters
CascadeDeleteAllowedProcedure SetChild DDs can specify if they will allow their records to be deleted as part of a cascade delete
CascadeDeleteNullProcedure SetAllows child DDs to specify if they should be deleted or have their child to parent relationship set to null
ClearAllRememberedDefaultsProcedureClears all dynamically assigned defaults for all DDOs in this structure
ClearRememberedDefaultsProcedureClears all dynamically assigned defaults for this one DDO
Data_SetFunctionReturns the object id of the DataDictionary object whose main file is passed to the function
Data_Set_ErrorProcedureDeclares DataDictionary object (DDO) errors
DDOConstraintFindMetaFunctionReturns Costraints MetaData information for a particular index
DDOConstraintNeedsRelateFunctionDetermines whether the constraints you are using require relates to determine if a record is valid
DDOConstraintsFunctionUsed to query array of DataFlex constraints
DefineAllExtendedFieldsProcedureObsolete Creates extended DataDictionary fields for all text and binary fields within a DataDictionary object (DDO)
DefineAsAliasProcedureSets this DD to work as an alias
DefineExtendedFieldProcedureObsolete Creates extended DataDictionary field for a text or binary field within a DataDictionary object (DDO)
ErrorMessageTableNameFunctionReturns the table name to be used when a DDO displays an error with a table name
Extended_Error_FieldFunctionExtends the extended error logic of the Error handler
Extended_Error_FileFunctionExtends the extended error logic of the Error handler
Extended_Error_MessageFunctionCalled by the standard DataFlex error handler when a DataDictionary error occurs
Field_Auto_IncrementFunctionReturns a column's auto-increment table and column number
Field_CommitNoEnterOnIndexFunctionDetermines if a committed table column that has an index should support entry
Field_Option_ClearProcedure SetClears a field option for a table column [Obsolete]
Field_Option_ToggleProcedure SetToggles a field option of a table column [Obsolete]
File_Field_AutoFindProcedurePerforms an AutoFind on a foreign table column
File_Field_Default_AutoFindProcedurePerforms an AutoFind on a foreign table column without setting the DDO's Changed_State to True
File_Field_DynamicEntryOptionsFunctionUsed to check the current state of NoPut and NoEnter field options
File_Field_EntryProcedure SetAllows you to place data into a DataDictionary field buffer using all the same logic that gets applied to data entry object/keyboard entry
File_Field_FindProcedureAllows you to simulate the find-key process of data entry objects within batch processes
File_Field_Option_ClearProcedure SetObsolete Clears a DD field option [Obsolete]
File_Field_Option_ToggleProcedure SetObsolete Toggles (reverse) the value of a DD field option [Obsolete]
File_Field_Pointer_EntryProcedure SetCalled to move data from an entry source to the DataDictionary (DD) extended buffer
FindProcedurePerforms a find operation on the DataDictionary's main data file using the passed mode and index
IsAliasFunctionReturns whether table is an alias table
IsCommittedFunctionCalled to determine if the record is committed
IsCommittedParentChangeAllowedFunctionCalled to determine if the server's parent is allowed to be switched
IsFieldCommittedFunctionCalled to determine if the column's commit field option is set
IsNullParentAllowedFunctionCalled to determine if an inactive parent DDO can be null
MasterForAliasFunctionReturns the master table for an alias table
Operation_Not_AllowedProcedureExecutes the error command with the passed in error number. Intended for augmentation
ParentNoSwitchIfCommittedProcedure SetDetermines if a parent record can be switched, once it is committed
ParentNullAllowedProcedure SetSpecifies whether a null parent is allowed or not
Remove_System_FileProcedureRemoves a table from this object's system file list
Request_ClearProcedureSee (and use) Clear [Obsolete]
Request_Validate_AllFunctionSimilar to Request_Validate, except that a validation will continue after a validation error has occurred
ResetChangedStatesProcedure
RestoreDefaultSQLFiltersProcedureRestores the global table SQL filters back to their original pre-find state
ShouldSaveConstrainedToServerFunctionDetermines if any relates-to constrained parent is changed
SQLEscapedStrFunctionConverts string to a string that is better suited and safer for SQL WHERE clauses
SQLStrAppendFunctionHelper function that will take two SQL filter strings and combine them using proper SQL AND syntax
SQLStrAppendOrFunctionHelper function that will take two SQL filter strings and combine them using proper SQL OR syntax
SQLStrFieldNameFunctionHelper function that returns a string representing the SQL column in a format that can be used by an SQL WHERE clause
SQLStrFileFieldNameFunctionHelper function that returns a string representing the SQL table and column in a format that can be used by an SQL WHERE clause
SQLStrFileNameFunctionHelper function that returns a string representing the SQL table name in a format that can be used by an SQL WHERE clause
SQLStrLikeFunctionHelper function that will create an SQL LIKE string for a table column and a target value to be used in the WHERE clause of SQL statements
SQLStrSchemaFileFieldNameFunctionHelper function that will create a string that that represents the SQL schema, table and column in a format that can be used by an SQL WHERE clause
StoreDefaultSQLFiltersProcedureStores any information about the table's current SQL filters
SupportsSQLFiltersFunctionCan be queried to determine if this table is capable of supporting SQL filtering and the Data Dictionary SQL filter interface

Inherited Methods from BaseData_Set

Add_Client_FileProcedureAdds a table to this object's related-child list (obsolete)
Add_Server_FileProcedureAdds a table to this object's related-parent list (obsolete)
Add_User_InterfaceProcedureAdds the passed in hoDEO to the list of data entry objects (DEOs) for this object
Attach_ServerProcedureUse DDO_Server instead [Obsolete]
AutoIncrementProcedureHandles incrementing of auto-increment columns
ClearProcedureClears all tables owned by this object
Clear_AllProcedureClears all files owned by this object and all connected server DataDictionary objects (DDOs)
ClearDDRelatesProcedureClears all local DD relationships
ClearForTableProcedureClears all tables owned by this object by redirecting Clear to the table's owner
CurrentRowIdFunctionReturns the RowId of the current record
Data_Set_PostFindProcedureHook after a find to allow application or removal of Data Dictionary SQL filters
Data_Set_PreFindProcedureHook prior to a find to allow application or removal of Data Dictionary SQL filters
Detach_ServerProcedureDisconnects this object and the specified DataDictionary object (DDO), where this object was the client of that DDO server
Establish_Find_DirectionProcedureInitializes the constrained find commands to perform searches using the given parameters
Find_By_RecnumProcedureFinds record in specified table with record number equal to the passed in record number
FindByRowIdProcedureFinds record in specified table with record identity equal to the passed RowId and updates the DDO structure
FindByRowIdExFunctionFinds 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
HasRecordFunctionDetermines if the DataDictionary object (DDO) has a current record
IsCascadeDeleteAllowedFunctionDetermines whether a child record can be deleted
IsRelatesToConstrainedFunctionDetermines if a child DDO is currently constrained to a particular parent table
Locate_NextProcedureFinds the next logical record using the passed in find mode, file, and index specified in a prior Establish_Find_Direction invocation
ParentDDOSwitchedFunctionDetermines whether the parent DDO has switched to a different record
Read_By_RecnumProcedureFinds record in specified tabile with record number equal to the passed in record number
ReadByRowIdProcedureFinds record in specified table with record identity equal to the passed RowId without updating or altering the DDO structure
ReadByRowIdExFunctionFinds 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
Rebuild_ConstraintsProcedureBuilds the constraint set for a DDO
RebuildAllConstraintsProcedureCan be sent to any DDO within a DDO structure to rebuild all constraint within the structure
Refind_RecordsProcedureChecks 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
Remove_Client_FileProcedureRemoves a table from this object's container-file list
Remove_Server_FileProcedureRemoves a table from this object's server-file list
Remove_User_InterfaceProcedureRemoves a table from this object's data entry object (DEO)-list
Request_AssignProcedureCauses the Refresh message to be sent to all data entry objects for this object and its client and server DataDictionary objects as appropriate
Request_Clear_FileProcedurePerforms the Clear command on the specified table of the data-server structure
Request_DeleteProcedureResponsible for deleting a record in the DDO for the main_file, updating all parent DDOs (and tables) and possibly deleting all child records
Request_Entry_UpdateProcedureSends 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
Request_FindProcedureFinds on specified table using given find mode and index
Request_ReadProcedureFinds on specified table using given find mode and index
Request_RelateProcedurePerforms a relate on the specified table without initializing the done-array
Request_SaveProcedureSaves all changes in DEOs attached to this object or to any DDO that is a server of this object directly or indirectly
Request_SuperfindProcedurePerforms superfind on the designated table by the Main_Index of the designated field and notifies all connected DataDictionary objects (DDOs) of the result
Request_ValidateFunctionRequest_Validate sends validation messages to all DDO Field's that will participate in the upcoming save
Validate_ConstraintsFunctionValidates this object's constraints against the record buffer's current content

Inherited Methods from cObject

ClassSuperClassFunctionReturns the superclass of the passed class
CreateFunctionCreates an object based on the passed Class Id
CreateNamedFunctionCreates an object based on the passed Class Id and assigns it a name Name based on a passed name
DestroyProcedureDestroys the object that receives the message and any child objects of that object
Exit_ApplicationProcedureStarts the process of closing an application
IsClassOfClassFunctionDetermines whether the target class is part of the searched class's hierarchy
IsObjectOfClassFunctionDetermines whether the passed class is part of the object's class hierarchy
ObjectClassFunctionReturns the integer class ID assigned to the class this object is based on
Request_Destroy_ObjectProcedureUse the Destroy method instead [Obsolete]