EventCollector.Commit Method

Article
12/03/2008

Submits an event batch to the application database.

Namespace: Microsoft.SqlServer.NotificationServices
Assembly: Microsoft.SqlServer.NotificationServices (in microsoft.sqlserver.notificationservices.dll)

Syntax

'Declaration
Public Function Commit As Integer

public int Commit ()

public:
virtual int Commit () sealed

public final int Commit ()

public final function Commit () : int

Return Value

An integer specifying how many events have been submitted in this Commit call.

Remarks

An event provider calls the Write method to submit an event (encapsulated as an Event) to an EventCollector. The EventCollector gathers all submitted events into an event batch. When the event provider calls the Commit method, the EventCollector submits the event batch to the Notification Services application database for processing.

The EventCollector creates a new event batch when the event provider first calls Write, and then again on the first Write call after an Abort or Commit call.

Example

The following examples show how to use the Commit method to commit an event batch.

These examples use the Microsoft.SqlServer.NotificationServices namespace.

Dim instanceName As String = "MyInstanceName"
Dim applicationName As String = "MyApplicationName"
Dim eventClassName As String = "MyEventClassName"
Dim eventProviderName As String = "MyEventProviderName"

'Create an NSInstance object.
Dim myInstance As New NSInstance(instanceName)

'Create an NSApplication object.
Dim myApplication As New NSApplication(myInstance, applicationName)

'Create an Event object.
Dim myEvent As New Microsoft.SqlServer.NotificationServices.Event( _
    myApplication, eventClassName)

'Create an EventCollector object.
Dim myEventCollector As _
    New EventCollector(myApplication, eventProviderName)

'Add code to collect event information here.

'Commit the event batch to the application database.
Dim eventsWritten As Integer = myEventCollector.Commit()

string instanceName = "MyInstanceName";
string applicationName = "MyApplicationName";
string eventClassName = "MyEventClassName";
string eventProviderName = "MyEventProviderName";

//Create an NSInstance object.
NSInstance myInstance = new NSInstance(instanceName);

//Create an NSApplication object.
NSApplication myApplication = 
    new NSApplication(myInstance, applicationName);

//Create an Event object.
Event myEvent = new Event(myApplication, eventClassName);

//Create an EventCollector object.
EventCollector myEventCollector = 
    new EventCollector(myApplication, eventProviderName);

//Add code to collect event information here.

//Commit the event batch to the application database.
int eventsWritten = myEventCollector.Commit();

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms