ph_setdata PowerHome formula function
Description
Sets the data value for a specified row
and column in a Data
Retrieval area
Syntax
ph_setdata ( i_dsvar, l_row, l_col, aa_data )
| Argument | Description |
| i_dsvar | Integer. The Data Retrieval area that holds
the data you want to set. Valid values are 1 thru 20 |
| l_row | Long. The row number for the data you want to set |
| l_col | Long. The column number for the data you want to set |
| aa_data | Any. The data value that you would like to set
to the specified row/column. The datatype supplied must match the column datatype |
Return value
Long. Returns 0 if successful. Returns
-1 if the i_dsvar parameter is out of range (1 - 20). Returns -2 if the
specified Data Retrieval area is not initialized. Returns -3 if the
specified row does not exist in the Data Retrieval area. Returns -4 if the
specified column does not exist in the Data Retrieval area. Returns -5
if function fails
Usage
Use this function to update and set
data in a Data
Retrieval area
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_setdata(1,5,2,"FAMILYRM") -
Returns 0 if successful. Sets row 5, column 2 in Data Retrieval area 1 to
the string value "FAMILYRM". The datatype for column 2 in Data Retrieval 1
must also be a string or character
datatype