ssCore.Catalog.results

Retrieve the results of a call to Catalog.Find.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

start - [Optional] - The first row that should be returned in Result. Valid values are from 0 to (Catalog.RowCount - 1). If you specify a value outside this range it will result in an error. Default value is 0.

count - [Optional] - The number of rows that should be returned in Result. Valid values are from 1 to Catalog.RowCount (or less, depending on the value of start).

fieldList - [Optional] - A list of field names that Catalog.Results should return. These can be in any order and fields can be repeated (if necessary). An empty field list ("") will return all fields in the order they appear in the catalog. Unrecognized field names will be ignored.


Output Parameters:

result - A string containing a collection of fields and rows with fields separated by tabs and rows separated by newline characters.


Asynchronous Mode:

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

ssCore.Catalog.results( 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.Catalog.results( paramsObject );


Notes:

This function should only be called after a successful call to Catalog.find.

If the combined value of start+count is greater than the number of rows in the catalog, the plugin will adjust count accordingly (no error will be generated).

start and count can be used to implement a scrolling listbox (browse) capability.

If you want to give your users the ability to select the fields that should be returned (with any catalog) you can obtain a list of fields in the loaded catalog by calling Catalog.fields.

                

Examples:

The following example gets the first 10 results from a previous find and displays the result in the SWF Studio Trace tab.

var return_obj = ssCore.Catalog.results({start:0, count:10, fieldList:"FirstName,LastName"});

ssDebug.trace(return_obj.result);