Note: This page includes content based on the F1 documentation for Centura development. It may be partially converted to support APF development, but should be regarded to be of uncertain actuality. It is provided as is. Eventually, it should be replaced by documentation available from within Visual Studio.
SalNumber DataRecordStateEvent( SalNumber nWhat, SalString sEvent )
Applications and the framework call the DataRecordStateEvent method to execute a state event for the selected records.
| Name | Description |
|---|---|
| SalNumber nWhat | Standard method parameter. Possible values are Const.METHOD_Inquire, Const.METHOD_Execute, Const.METHOD_GetType. |
| SalString sEvent | Name of event to execute. |
When nWhat = Const.METHOD_Inquire: the return value is TRUE if there are no changes to the data source and sEvent is available for the current records current state. If several records are selected, the return value is TRUE if the sEvent is available in all the selected records current states. In other cases the return value is FALSE.
When nWhat = Const.METHOD_Execute: the return value is TRUE if the event was successfully executed for all selected records.
When nWhat = Const.METHOD_GetType, the return value is Const.CHILDTYPE_SourceMethod.
DataRecordStateEvent is called automatically by the framework when a data source receives the Const.PM_DataRecordStateEvent message.