SetRecordsValues()

Writes a value or sequence of numbers into a range of cells in a view on a table.

Value method can use more than one value from Version 6.0/2012. Value method changed to Values method in Version 2016.

SetRecordsValues(string view_set_name, array region, string method, array params, array options)

Argument	Contents
view_set _name	The name of the view\|set into which values are written, or null for the current view\|set
region	An array of two elements, {array columns, array rows}, with field names for the columns and record handles for the rows
method	"Values" to write an array of values into the cells of the view\|set, "Sequence" to write a series of numbers into the cells of the view\|set, or "Formula" to use an expression, such as the name of another column (including a formula field), to copy the values into the cells of the view\|set
params	For Values method, an array of arrays, with an array of values for each field for each row. That is, the array of values must be the same length as the number of rows, with each element in that array being made up of an array of values, one for each field.For Sequence method, an array containing the start_value and step_value.For Formula method, an array containing the column name of a formula field.

No options are currently supported.

The region array is identical in format to that returned by GetEditorHighlight().
If columns or rows in the region array are null, all columns or rows are filled, respectively.
For the Values method, if the array has only one value it will be used for all cells.

// Fill the SeqNum column with 1, 2, 3, etc.

SetRecordsValues(null, {{"SeqNum"}, null}, "Sequence", {1, 1}, )

// Fill the ZIP and N columns with the value of zip_code and -7, resp.

SetRecordsValues(null, {{"ZIP", "N"}, }, "Value", {zip_code, -7}, )

Error Type	Meaning
Error	The region or method is invalid
NotFound	There is no view of the given name

Function	Summary
GetDataVector()	Creates a vector from a field in a view\|set
GetDataVectors()	Creates vectors from fields in a view\|set
GetFields()	Gets a list of the fields in a view
GetRecord()	Gets the record handle of the current record of a view
GetRecordValues()	Reads the values of one or more fields for a record in a view
GetRecordsValues()	Reads the values of one or more fields for a record in a view
LocateRecord()	Locates a record based on the value of a field
SetDataVector()	Fills values into a field in a view\|set from a vector
SetDataVectors()	Fills values into fields in a view\|set from vectors
SetEditorValues()	Writes a value or sequence of numbers into a range of cells in an editor window
SetRecord()	Sets the current record of a view
SetRecordValues()	Updates the data for a record in a view