DataRecordRemove

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 DataRecordRemove( SalNumber nWhat )

Applications and the framework call the DataRecordRemove method to mark records for removal from a data source.

Parameters

Name Description
SalNumber nWhat Standard method parameter. Possible values are Const.METHOD_Inquire, Const.METHOD_Execute, Const.METHOD_GetType.

Returns

When nWhat = Const.METHOD_Inquire: the return value is TRUE if the remove operation is available, FALSE otherwise.

When nWhat = Const.METHOD_Execute: the return value is TRUE if the record was successfully removed, FALSE otherwise.

When nWhat = Const.METHOD_GetType, the return value is Const.CHILDTYPE_SourceMethod.

Comments

DataRecordRemove is called automatically by the framework when a data source receives the Const.PM_DataRecordRemove message.