| ibi Patterns - Search 6.0.0 .NET API |
| NetricsServerInterface.checkpointObjects Method |
| See AlsoExample |
 
|
Checkpoint objects (tables, thesauri, character maps, rlink models) currently loaded in the ibi™ Patterns - Search Server.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function checkpointObjects( _ ByVal objects As NetricsObjectNameCollection _ ) As NetricsObjectNameCollection |
| C# |
|---|
| public NetricsObjectNameCollection checkpointObjects( NetricsObjectNameCollection objects ) |
| C++ |
|---|
| public: NetricsObjectNameCollection checkpointObjects( NetricsObjectNameCollection objects ) sealed |
| J# |
|---|
| public NetricsObjectNameCollection checkpointObjects( NetricsObjectNameCollection objects ) |
| JScript |
|---|
| public
function checkpointObjects( objects : NetricsObjectNameCollection ) : NetricsObjectNameCollection |
Parameters
- objects
- The names of the objects to be checkpointed. Pass null to checkpoint all objects currently in the server.
Return Value
An NetricsObjectNameCollection containing the names of the objects that were successfully checkpointed.
Exceptions
| Exception Type | Condition |
|---|---|
| NetricsException | If the server indicates that an error has occured (Possible errors - DBPARAM, NODBDESC, EXPECTDBDESC, DUPDBDESCS, FEATURESET, DBNOTFOUND, PARTIALCHPT, CHPTFAILED, INTERNAL, NOSYSINIT) |
| IOException | If an I/O error occurs. |
Remarks
Checkpointing an object allows it to be restored to the state it was in at the time of the checkpoint. A checkpoint is made to a permanent file store, so checkpoints can be restored across different server invocations. A checkpoint restore is the fastest way to load an object.
In order to checkpoint an object the server must have been started with checkpointing enabled. See the server user's manual for information on how to enable checkpointing.
If one or more of the named objects does not exist a NetricsException is thrown with an error code of DBNOTFOUND. All objects that were found are checkpointed.
If some, but not all, of the objects fail to checkpoint for any other reason a NetricsException is thrown with error code PARTIALCHPT. Again some objects may have checkpointed successfully in this case.
If all objects fail to checkpoint correctly and not all of them failed because the named table didn't exist a NetricsException is thrown with error code CHPTFAILED.
The extended error item will be a generic list containing the descriptor for each object that failed to checkpoint correctly for any reason.
If tables and/or thesauri with user-defined character maps are specified, those user-defined character maps are automatically added to the set of objects to checkpoint.