IHttpProtocolProvider.FormatEnvelope Method

  • [アーティクル]

ディストリビュータはこのメソッドを使用して、フォーマット済み通知データを配信プロトコルに渡します。データを受け取った配信プロトコルはこの情報を使用して、送信される HTTP メッセージに対して適切にフォーマットされた本文を作成します。この本文にはコンテンツ フォーマッタによって返される通知テキストがラップされるため、この本文はエンベロープと呼ばれます。

名前空間: Microsoft.SqlServer.NotificationServices
アセンブリ: Microsoft.SqlServer.NotificationServices (microsoft.sqlserver.notificationservices.dll 内)

構文

'宣言
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

パラメータ

  • protocolFields
    アプリケーション定義で指定した、配信される通知のプロトコル フィールドが含まれる StringDictionary です。
  • requestBody
    コンテンツ フォーマッタによって生成された、フォーマット済み通知データを含む文字列です。これが HTTP 要求の本文になります。

戻り値

フォーマット済みエンベロープを含む文字列です。

解説

このメソッドは、内部 HTTPExtension クラスが HTTP メッセージの本文として送信できる文字列を返す必要があります。

適切なメカニズムを使用すると、引数の値を評価して、文字列を作成できます。この場合、送信機能をコーディングする必要はありません。送信は、Notification Services の内部 HttpExtension クラスによって処理されます。

使用例

FormatEnvelope メソッドを実装する方法の例については、IHttpProtocolProvider のトピックを参照してください。

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

IHttpProtocolProvider Interface
IHttpProtocolProvider Members
Microsoft.SqlServer.NotificationServices Namespace