DataRecordPaste

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

DataRecordPaste copies a record (object) from the clipboard to the datasource.

Parameters

Name Description
SaNumber 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 new operation is available and if there is an object currently stored in the clipboard, FALSE otherwise.

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

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

Comments

Pasting is done in the following way:

  1. Create space for new record (e.g. clear fields or insert a new table row)
  2. Get values of parent keys from parent data source (if any)
  3. Call DataRecordGetDefaults to get client default values
  4. Call DataRecordPrepareNew to get server default values
  5. Clear all child data sources (if any)
  6. Put the clipboard stored values in the new record.

For a field to get a stored value in step 6, the field must be editable and insertable. If the field is an attribute the stored values overwrite any client or server default values. If the field is a key, the stored values will NOT overwrite any client or server default values.

DataRecordPaste is called automatically by the framework when a data source receives the PM_DataRecordPaste message