ssCore.ADO.getRows

Retrieve any or all rows from the current result set.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

rows - [Optional] - The number of rows to retrieve. Use "-1" to retrieve all rows. Default value is -1.


Output Parameters:

result - A string which contains the requested row data.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.ADO.getRows( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.ADO.getRows( paramsObject );


Notes:

See ADO.setRowFormat for details on retrieving row data in other formats.

See ADO.setSeparator for details on changing the row separator value from the default newline ("\n").

Only the fields specified in ADO.setFieldList are returned. If you don't call ADO.setFieldList all fields will be returned by default.

If you set rows to "-1", all rows will be returned in a single call to ADO.getRows. If you set rows to any other positive value, ADO.getRows will attempt to return the requested number of rows starting at the current row and may return less than rows. If no more rows are available, the function will fail (error code will be set to "8", indicating end-of-file).

                

Examples:

var return_obj = ssCore.ADO.getRows({rows:-1});

ssDebug.trace(return_obj.result);