IHttpProtocolProvider.FormatEnvelope Method

Article
12/03/2008

The distributor uses this method to pass formatted notification data to the delivery protocol, which then uses this information to create an appropriately formatted body for the HTTP message that will be sent. This body is referred to as an envelope, because it wraps the notification text returned by the content formatter.

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

Syntax

'Declaration
Function FormatEnvelope ( _
    protocolFields As StringDictionary, _
    requestBody As String _
) As String

string FormatEnvelope (
    StringDictionary protocolFields,
    string requestBody
)

String^ FormatEnvelope (
    StringDictionary^ protocolFields, 
    String^ requestBody
)

String FormatEnvelope (
    StringDictionary protocolFields, 
    String requestBody
)

function FormatEnvelope (
    protocolFields : StringDictionary, 
    requestBody : String
) : String

Parameters

protocolFields
A StringDictionary containing the protocol fields for the notifications to be delivered, as specified in the application definition.

requestBody
A string containing the formatted notification data that was produced by the content formatter. This becomes the body of the HTTP request.

Return Value

A string containing the formatted envelope.

Remarks

This method needs to return a string that the internal HTTPExtension class can send as the body of the HTTP message.

You can use any appropriate mechanism to evaluate the values in the arguments and create string. No send functionality needs to be coded here; this is handled by the Notification Services internal HttpExtension class.

Example

For an example of how to implement the FormatEnvelope method, see the IHttpProtocolProvider 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