The ICogTool type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| CreateCurrentRecord |
Creates a new set of records that represents the tool's current state.
| |
| CreateLastRunRecord |
Creates a new set of records that represents the tool's last-run state.
| |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event if the
ChangedEventSuspended count is reduced to zero and any changes were
made while events were suspended. Must be called once for each call to
SuspendChangedEvent.
(Inherited from ICogChangedEvent.) | |
| Run |
Runs the tool. This method is guaranteed to not throw an
exception. Any exception generated in the course of running
the tool will be caught and packaged in the tool's
RunStatus.Exception. Should this occur, the tool's RunStatus.Result
will be set to Error and its RunStatus.Message will reference the
message that accompanied the exception. It is the user's
responsibility to examine the tool's RunStatus after calling Run.
| |
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from ICogChangedEvent.) |
See Also