ph_insertdata PowerHome formula function
Description
Inserts a blank row into a Data
Retrieval area
Syntax
ph_insertdata ( ai_dsvar, al_row )
| Argument | Description |
| ai_dsvar | Integer. The number of the previously defined
Data Retrieval you wish to insert a row. Valid values are 1 thru 20 |
| al_row | Long. The number of an existing row that you
want to insert the new row before. Use 0 to add a row to the end |
Return value
Long. Returns the row number of the
new row.
Returns one of the negative numbers below if
an error occurs
-1 The ai_dsvar value is out of range (must be 1 thru 20)
-2 The specified ai_dsvar number is not initialized
-3 the specified row is not valid. The row must be 1
thru the current number of rows in the Data Retrieval area or 0 to insert at the
end
Usage
Use this function to insert blank rows into
an existing Data Retrieval area. If the Data Retrieval area currently contains 5
rows and you insert a new row 3, the current row 3 will become row 4 and
the Data Retrieval area will now contain 6 rows. In this case, the function will
return the number 3. If you insert at row 0 into the same Data Retrieval area
that currently contains 6 rows, the new row will become row 7 and the number 7
will
be returned
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_insertdata(1,5) - Returns the
number 5 if Data Retrieval area 1 is initialized and has at least 5 existing
rows