WsCreateChannel 関数 (webservices.h)

  • [アーティクル]

エンドポイントとのメッセージ交換用 のチャネル を作成します。

構文

HRESULT WsCreateChannel(
  [in]           WS_CHANNEL_TYPE               channelType,
  [in]           WS_CHANNEL_BINDING            channelBinding,
  [in]           const WS_CHANNEL_PROPERTY     *properties,
  [in]           ULONG                         propertyCount,
  [in, optional] const WS_SECURITY_DESCRIPTION *securityDescription,
                 WS_CHANNEL                    **channel,
  [in, optional] WS_ERROR                      *error
);

パラメーター

[in] channelType

チャネルの型。 チャネルの種類については、 WS_CHANNEL_TYPE 列挙を参照してください。 これは、作成されるチャネルのメッセージ交換パターンを表します。

[in] channelBinding

チャネル バインド。新しいチャネルに使用するプロトコル スタックを示します。 使用可能なチャネル バインドについては、「 WS_CHANNEL_BINDING 列挙」を参照してください。

[in] properties

チャネル初期化の省略可能な値を含む WS_CHANNEL_PROPERTY 構造体の配列。 このパラメーターの値は NULL にすることができます。この場合、 propertyCount パラメーターは 0 (ゼロ) である必要があります。

チャネルの作成時に指定できるチャネル プロパティについては、 WS_CHANNEL_PROPERTY_ID 列挙を参照してください。

カスタム チャネルの作成については、「解説」セクションを参照してください。

[in] propertyCount

プロパティ配列内の プロパティ の数。

[in, optional] securityDescription

チャネルのセキュリティを指定する WS_SECURITY_DESCRIPTION 構造体へのポインター。

( WS_CHANNEL_BINDING 列挙のWS_CUSTOM_CHANNEL_BINDING値を使用して) カスタム チャネルを作成する場合、セキュリティの説明は NULL である必要があります。 「解説」を参照してください。

channel

作成されたチャネルのアドレスを受け取るポインター。
チャネルが不要になったら、 WsFreeChannel を呼び出してチャネルを解放する必要があります。

[in, optional] error

関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。

戻り値

関数が成功すると、NO_ERRORが返されます。それ以外の場合は、HRESULT エラー コードが返されます。

リターン コード 説明
E_INVALIDARG
 1 つ以上の引数が無効です。
E_OUTOFMEMORY
 操作を完了するにはメモリが不足しています。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

注釈

WsOpenChannel 関数を使用して、チャネルでの通信を開始し、エンドポイントを指定します。

( WS_CHANNEL_BINDING 列挙のWS_CUSTOM_CHANNEL_BINDING値を使用して) カスタム チャネルを作成する場合は、次のチャネル プロパティのみを指定できます。

  • WS_CHANNEL_PROPERTY_CUSTOM_CHANNEL_CALLBACKS
  • WS_CHANNEL_PROPERTY_CUSTOM_CHANNEL_PARAMETERS
( WS_CHANNEL_PROPERTY_ID 列挙を参照)カスタム チャネルを作成するために初期プロパティが必要な場合は、WS_CHANNEL_PROPERTY_CUSTOM_CHANNEL_PARAMETERS プロパティを使用して指定します。

カスタム チャネル実装にセキュリティ情報を渡すには、 WS_CHANNEL_PROPERTY_ID 列挙のWS_CHANNEL_PROPERTY_CUSTOM_CHANNEL_PARAMETERS値を使用します。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー webservices.h
Library WebServices.lib
[DLL] WebServices.dll