Description:
The Delete
method deletes an event (entry) from
the event log database.
This method can be called both synchronously and asynchronously.
Syntax:
For synchronous calls:
result = so.IDataSource.Delete(criteria);
For asynchronous calls:
result = so.IDataSource.Delete(criteria, callback);
Arguments:
criteria
:
This is an object that specifies which event to delete from the log event database. For more information about the object properties and how to define them, see section Criteria for deleting an event.
callback
:
The callback
argument is the name of the method
that is executed when an asynchronous Delete
call has
results or status information to return. You must define this method separately.
Follow the instructions in section Defining the callback handler for an asynchronous method to
define the callback
method.
This argument is used only with an asynchronous Delete
call.
Return value:
If synchronous, the Delete
method returns an error
code and an error message.
Property |
Description |
Value |
---|---|---|
|
This is a number that specifies a predefined error code. |
|
|
This is a text string that describes the error. |
If asynchronous, the method returns an object that contains a transaction
ID for the callback
instance,
an error code, and an error message (see the following table). When the asynchronous
call has completed, callback
returns an object that contains
an error code and an error message (see Table:
Callback return value).
Property |
Description |
Value |
---|---|---|
|
This is a number used as an identification to match transactions started
with the asynchronous This property is only valid for asynchronous calls. |
|
|
This is a number that specifies a predefined error code. |
|
|
This is a text string that describes the error. |
Example code:
For the complete source of a sample widget that demonstrates how to use this Service API, see the full example.