Data Form and Data Table: _setEntry

Data Form and Data Table: _setEntry

Sets the name of the DATAFORM catalog entry associated with the model

Delegated to: Data Set Data Model class

Syntax
Details

Syntax

CALL SEND (model-id, '_setEntry', entry<, return-code<, replace>>);

Argument Type Description

entry
C specifies the name of the DATAFORM catalog entry associated with the model

return-code
N contains the return code from _setEntry:

3 entry does not yet exist and previously specified entry does exist. Result: A DATAFORM catalog entry by the new name is created on the next _writeEntry call.

2 entry could not be opened for writing; the entry exists, but the user does not have WRITE access to it.
Result: The DATAFORM catalog entry is successfully read, but calls to the _writeEntry method do not save any customizations to that DATAFORM entry.

1 entry does not yet exist and previously specified entry does not exist. Result: A DATAFORM catalog entry by the new name is created on the next _writeEntry call.

0 entry successfully opened

-1 invalid library or entry name Result: The model is not changed at all by the _setEntry call.

-2 discrepancy between the column information in the DATAFORM catalog entry and that in the model information. This situation can happen if the DATAFORM entry contains a column that is noncomputed and does not currently exist in the model. Result: The new noncomputed column from the entry is not added to the model.

-3 out-of-memory condition

-4 there is already a column in the model by the same name as a column in the entry and the two like-named columns are of different type. Result: The new column from the entry is not moved to the model; the existing model column remains unchanged.

-5 both the conditions described above for values of -2 and -4 occurred (discrepancy between the columns, and there is already a column in the model by the same name as a column in entry and the existing columns are of different types)

replace
C specifies whether to replace the existing columns with the columns from the new entry:

'Y' replace the existing columns with columns from the new entry (default)

'N' do not replace the existing columns; the columns from the new entry are merged with the existing columns.

Argument	Type	Description
entry	C	specifies the name of the DATAFORM catalog entry associated with the model
return-code	N	contains the return code from _setEntry:
		3	entry does not yet exist and previously specified entry does exist. Result: A DATAFORM catalog entry by the new name is created on the next _writeEntry call.
		2	entry could not be opened for writing; the entry exists, but the user does not have WRITE access to it. Result: The DATAFORM catalog entry is successfully read, but calls to the _writeEntry method do not save any customizations to that DATAFORM entry.
		1	entry does not yet exist and previously specified entry does not exist. Result: A DATAFORM catalog entry by the new name is created on the next _writeEntry call.
		0	entry successfully opened
		-1	invalid library or entry name Result: The model is not changed at all by the _setEntry call.
		-2	discrepancy between the column information in the DATAFORM catalog entry and that in the model information. This situation can happen if the DATAFORM entry contains a column that is noncomputed and does not currently exist in the model. Result: The new noncomputed column from the entry is not added to the model.
		-3	out-of-memory condition
		-4	there is already a column in the model by the same name as a column in the entry and the two like-named columns are of different type. Result: The new column from the entry is not moved to the model; the existing model column remains unchanged.
		-5	both the conditions described above for values of `-2` and `-4` occurred (discrepancy between the columns, and there is already a column in the model by the same name as a column in entry and the existing columns are of different types)
replace	C	specifies whether to replace the existing columns with the columns from the new entry:
		'Y'	replace the existing columns with columns from the new entry (default)
		'N'	do not replace the existing columns; the columns from the new entry are merged with the existing columns.

Details

The DATAFORM catalog entry name can be a two-level or four-level name.

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

If there is a column in the entry that is not in the model, it will be added to the model only if the new column is a computed column. Otherwise, the new column will not be added (see -2 above).

If there is a column in the entry that has the same name as a column in the model, the column from the entry will be added to the model if the new column and the model column are both of the same type. Otherwise, the new column will not be added (see -4 above).

See DATAFORM Catalog Entries for more information.

Chapter Contents
Previous
Next
Top of Page