ssCore.Catalog.load

Load a catalog into memory in preparation for searching.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified path to the catalog table. You can provide just the catalog file name if it's an internal file in the root of the layout. This parameter supports monikers.


Output Parameters:

No output parameters.


Asynchronous Mode:

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

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


Notes:

If this command fails, you should not attempt any other operations on the catalog.

                

Examples:

ssCore.Catalog.load({path:"startdir://file.cat"});