IScheduledEventProvider.Initialize Method

Article
12/03/2008

Initializes the event provider.

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

Syntax

'Declaration
Sub Initialize ( _
    nsApplication As NSApplication, _
    providerName As String, _
    args As StringDictionary, _
    stopDelegate As StopHandler _
)

void Initialize (
    NSApplication nsApplication,
    string providerName,
    StringDictionary args,
    StopHandler stopDelegate
)

void Initialize (
    NSApplication^ nsApplication, 
    String^ providerName, 
    StringDictionary^ args, 
    StopHandler^ stopDelegate
)

void Initialize (
    NSApplication nsApplication, 
    String providerName, 
    StringDictionary args, 
    StopHandler stopDelegate
)

function Initialize (
    nsApplication : NSApplication, 
    providerName : String, 
    args : StringDictionary, 
    stopDelegate : StopHandler
)

Parameters

nsApplication
An NSApplication representing the Notification Services application to which this event provider delivers events.

providerName
A String containing the name of the event provider, as specified in the application definition.

args
A StringDictionary containing the names and values of the initialization arguments, as specified in the application definition.

stopDelegate
A StopHandler delegate that the event provider can use to call back to the provider host to request termination.

Note that the event provider is not initialized until the Initialize method completes. Calling stopDelegate during initialization has no effect.

Remarks

The provider host calls this method to notify the scheduled event provider that it must perform initialization. The args parameter provides the initialization arguments for the event provider. For more information about event provider arguments, see Defining Hosted Event Providers.

You use the values provided in the args parameter to set class variables and prepare the event provider to run. This often involves setting information about the event source that the event provider monitors and the event class that defines the events that the event provider creates.

The event provider host calls the Initialize method when it starts. The event provider returns as soon as initialization is complete. The provider host always calls Initialize before calling the Run or Terminate method.

The Initialize method has a five-minute time-out window. If initialization has not completed within that time, an error is logged and the event provider's Terminate method is called.

Example

For an example of how to implement the Initialize method, see the IScheduledEventProvider topic.

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