Form Data Model: _writeEntryFromList

Form Data Model: _writeEntryFromList

Updates the model's information from a list

Syntax
Details

Syntax

CALL SEND (model-id, '_writeEntryFromList', list<, update<, return-code>>);

Argument Type Description

list
N specifies the identifier of an SCL list that contains named items corresponding to the model information to be updated

update
C specifies whether to send the latest information to the viewer and model after reading the list:

'Y' update

'N' do not update

return-code
N contains the return code from _writeEntryFromList:

0 entry successfully updated

-2 discrepancy between the column information in the list and that in the current model information. This discrepancy can happen if the new list contains a column that does not exist in the current model information and the new column is not a computed column.

-3 out-of-memory condition

-4 a column in the list is already in the current model information but in one place the column is numeric while in the other it is character.

-5 the conditions corresponding to a return code of -2 as well as the conditions corresponding to a return code of -4 both occurred (discrepancy between the columns and like-named column in list and entry of different types).

Argument	Type	Description
list	N	specifies the identifier of an SCL list that contains named items corresponding to the model information to be updated
update	C	specifies whether to send the latest information to the viewer and model after reading the list:
		'Y'	update
		'N'	do not update
return-code	N	contains the return code from _writeEntryFromList:
		0	entry successfully updated
		-2	discrepancy between the column information in the list and that in the current model information. This discrepancy can happen if the new list contains a column that does not exist in the current model information and the new column is not a computed column.
		-3	out-of-memory condition
		-4	a column in the list is already in the current model information but in one place the column is numeric while in the other it is character.
		-5	the conditions corresponding to a return code of `-2` as well as the conditions corresponding to a return code of `-4` both occurred (discrepancy between the columns and like-named column in list and entry of different types).

Details

The _writeEntryFromList method is useful for updating the model's state. You can call this method with a list that was obtained by a previous _readEntryIntoList method call. The _writeEntryFromList method updates the model's information from the named items in list.

The _writeEntryFromList method does not actually save a DATAFORM entry. To save the information from the list to a DATAFORM entry, you should call _writeEntry.

You can use the return-code argument to determine if the _writeEntryFromList call was successful.

Chapter Contents
Previous
Next
Top of Page