IContentFormatter.Initialize Method

Article
12/03/2008

Initializes the content formatter.

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

Syntax

'Declaration
Sub Initialize ( _
    arguments As StringDictionary, _
    digest As Boolean _
)

void Initialize (
    StringDictionary arguments,
    bool digest
)

void Initialize (
    StringDictionary^ arguments, 
    bool digest
)

void Initialize (
    StringDictionary arguments, 
    boolean digest
)

function Initialize (
    arguments : StringDictionary, 
    digest : boolean
)

Parameters

arguments
A StringDictionary object containing the names and values of the content formatter initialization arguments as configured in the application definition.

digest
A Boolean value indicating whether the notification class for which the content formatter is being used has digest delivery enabled. If this parameter is true, then multiple sets of notification data that are passed in a single call to FormatContent should be aggregated into a single digest notification.

Remarks

The distributor calls this method to notify the content formatter that it must perform initialization. The arguments parameter provides the initialization arguments for the content formatter. For more information, see Configuring Content Formatters.

The digest parameter indicates whether digest delivery is being used by the notification class. The content formatter should store the value of this parameter, and use it to decide whether to do digest aggregation in the call to the FormatContent method.

Example

For an example of how to implement the Initialize method, see the IContentFormatter interface 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