Restore objects previously checkpointed.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function restoreObjects( _ ByVal objects As NetricsObjectNameCollection _ ) As NetricsObjectNameCollection |
| C# |
|---|
| public NetricsObjectNameCollection restoreObjects( NetricsObjectNameCollection objects ) |
| C++ |
|---|
| public: NetricsObjectNameCollection restoreObjects( NetricsObjectNameCollection objects ) sealed |
| J# |
|---|
| public NetricsObjectNameCollection restoreObjects( NetricsObjectNameCollection objects ) |
| JScript |
|---|
| public
function restoreObjects( objects : NetricsObjectNameCollection ) : NetricsObjectNameCollection |
Return Value
An NetricsObjectNameCollection containing the names of the objects that were successfully restored.
Exceptions
| Exception Type | Condition |
|---|---|
| NetricsException | If the server indicates that an error has occured (Possible errors - DBPARAM, NODBDESC, EXPECTDBDESC, DUPDBDESCS, FEATURESET, PARTIALRESTORE, RESTOREFAILED, INTERNAL, NOSYSINIT, SHUTDOWN) |
| IOException | If an I/O error occurs. |
Remarks
This restores objects to the state of the latest checkpoint for those objects. The checkpoint could have been made from this invocation of the server, in which case this backs up the state of the objects to that at the time of the last checkpoint, or in a previous invocation of the server, in which case this is a way to quickly reload objects.
When user-defined character-maps are in use, it is strongly recommended that objects include all character maps.
In order to restore objects the server must have been started with checkpointing enabled. See the server user's manual for information on how to enable checkpointing.
If some, but not all, of the objects fail to restore a NetricsException is thrown with error code PARTIALRESTORE.
If all objects fail to restore correctly a NetricsException is thrown with error code RESTOREFAILED.
The names of the objects to be restored. Pass null to restore all objects that were previously checkpointed.