DDRefreshTableStatus - cDbCJGrid
Used inside of the Refresh event to determine if a table has participated in the current DataDictionary operation
Type: Function
Return Data Type: Integer
Parameters
| Parameter | Type | Description |
|---|---|---|
| iTable | Integer | Table handle to check |
Syntax
Function DDRefreshTableStatus Integer iTable Returns Integer
Call Example
Get DDRefreshTableStatus iTable to IntegerVariable
Description
DDRefreshTableStatus lets you know how a table participated in the DataDictionary process that triggered the Refresh event. During a DataDictionary operation (Request_Find, Request_Save, etc.), the DataDictionary Object (DDO) will send Refresh to all data entry objects (DEOs) connected to the DDO. The Refresh event is sent a mode parameter that indicates what type of DDO operation triggered this event. If you are augmenting Refresh, you can use this mode to customize your augmentation. DDO operations are complex; a single operation, such as a find, might result in records within the DDO being cleared, found or left alone. Therefore, you might need to know how a particular table participated in the DDO change. DDRefreshTableStatus does this. It can only be called within Refresh, is passed a table number and returns if that table was found (ddrstFound), cleared ((drtsCleared) or was not part of this operation (drtsNone).
For example, finding a parent table might result in this message showing that the parent (and its parents) were all found (ddrstFound) while the main-file and other branches did nothing (drtsNone).
| Col 1 | Col 2 |
|---|---|
| Note: | DDRefreshTableStatus can only be called inside the Refresh event. |
Return Value
ddrtsFound, ddrtsCleared, ddrtsNone