WSCInstallProviderAndChains 関数 (ws2spi.h)

注意

階層型サービス プロバイダーは非推奨です。 Windows 8とWindows Server 2012以降では、Windows フィルター プラットフォームを使用しますWSCInstallProviderAndChains 関数は、指定された 32 ビット トランスポート プロバイダーとその特定のプロトコル チェーンを、32 ビット コンピューター上の Winsock 2 システム構成データベースにインストールします。 この関数により、トランスポート プロバイダー構成情報の先頭にプロトコル チェーンが順序付けされ、 WSCWriteProviderOrder の個別の呼び出しが不要になります。

構文

int WSCInstallProviderAndChains(
  [in]            LPGUID              lpProviderId,
  [in]            const LPWSTR        lpszProviderDllPath,
  [in]            const LPWSTR        lpszLspName,
  [in]            DWORD               dwServiceFlags,
  [in]            LPWSAPROTOCOL_INFOW lpProtocolInfoList,
  [in]            DWORD               dwNumberOfEntries,
  [out, optional] LPDWORD             lpdwCatalogEntryId,
  [out]           LPINT               lpErrno
);

パラメーター

[in] lpProviderId

プロバイダー固有のグローバル一意識別子 (GUID) へのポインター。

[in] lpszProviderDllPath

プロバイダーの DLL への読み込みパスを含む Unicode 文字列へのポインター。 この文字列は、パス解決の通常の規則を確認し、埋め込み環境文字列 (%SystemRoot%など) を含めることができます。 このような環境文字列は、 Ws2_32.dll 後にアプリケーションの代わりにプロバイダー DLL を読み込むたびに展開されます。 埋め込まれた環境文字列が展開されると、 Ws2_32.dll は結果の文字列を LoadLibrary 関数に渡して、プロバイダーをメモリに読み込みます。 詳細については、「 LoadLibrary」を参照してください。

[in] lpszLspName

ソケット プロバイダーの名前を含む Unicode 文字列へのポインター。

[in] dwServiceFlags

作成する "ダミー" カタログ エントリの種類に対するサービス フラグ。

ダミー エントリは、ChainLen メンバーが 0 に設定されたWSAProtocol_Info構造体です。 実際の LSP カタログ エントリは、 ProtocolChain メンバー内のこのダミー エントリの ID を参照します。

このパラメーターに設定できるフラグは次のとおりです。

意味
XP1_IFS_HANDLES
カタログ エントリは、IFS 固有のソケット ハンドルを返すインストール可能ファイル システム (IFS) LSP 用です。 これらのハンドルは、呼び出し元のアプリケーションに直接返されます。 IFS LSP は Winsock 呼び出しの完了をインターセプトできず、すべての Winsock 関数を実装または使用できる必要はありません。

[in] lpProtocolInfoList

WSAProtocol_Info構造体の配列へのポインター。 各構造体は、プロバイダーによってサポートされるプロトコル、アドレス ファミリ、ソケットの種類を定義します。 検査される WSAPROTOCOL_INFO 構造体のメンバーは、 iProtocoliAddressFamilyおよび iSocketType です

[in] dwNumberOfEntries

lpProtocolInfoList 配列内のエントリの数。

[out, optional] lpdwCatalogEntryId

Winsock 2 システム構成データベース内のトランスポート プロバイダーの新しくインストールされた "ダミー" エントリへのポインターを受け取ります。 この ID は、LSP のカタログ エントリをインストールするために使用されます。

[out] lpErrno

関数が失敗した場合に呼び出しによって生成されたエラー コードを受け取るポインター。

戻り値

状況
WSCInstallProviderAndChains は 成功し、0 を返します。 それ以外の場合は 、SOCKET_ERRORを返し、 lpErrno パラメーターで特定のエラー コードが返されます。

エラー コード 意味
WSAEFAULT
1 つ以上の引数がユーザー・アドレス・スペースの有効な部分にありません。
WSAEINVAL
1 つ以上の引数が無効です。 lpProviderId パラメーターが **NULL**、lpszProviderDllPath パラメーターが無効であるか、パスの長さが大きすぎる (**MAX_PATH** を超えました)、lpszLspName パラメーターが無効であるか、名前の長さが大きすぎる (**WSAPROTOCOL_LEN** を超えています)、lpProtocolInfoList が非**NULL** に設定され、dwNumberOfEntries が返されます。パラメーターが 0 であるか、重複するプロバイダー ID または階層化されたサービス プロバイダー名がカタログに既に存在するか、指定されたプロトコル、アドレス ファミリ、ソケットの種類に一致するものが見つかりません。
WSAEINPROGRESS
プロバイダーのインストールは既に進行中です。
WSAEINVALIDPROCTABLE
プロバイダーに必要な機能がありません。
WSAENOBUFS
バッファーにメモリを割り当てることはできません。
WSANO_RECOVERY
回復不可能なエラーが発生しました。 このエラーは、プロバイダーが既にインストールされている、 lpProtocolInfoList パラメーターが **NULL** で、ベース プロバイダーが見つからなかった、プロトコル チェーンの最大長 (**MAX_PROTOCOL_CHAIN**) に達した、ユーザーが Winsock レジストリへの書き込みに必要な管理特権がない、カタログ エントリの作成またはインストール時にエラーが発生したなど、いくつかの条件で返されます。
WSASYSCALLFAILURE
失敗しないシステム呼び出しが失敗しました。

注釈

WSCInstallProviderAndChains は、単一のトランスポート サービス プロバイダーをインストールするために使用される基本的な WSCInstallProvider 関数の拡張バージョンです。 レイヤード サービス プロバイダーがインストールされている場合は、 WSCInstallProviderAndChains を使用する必要があります。 WSCInstallProviderAndChains では、1 つの関数呼び出しを使用して、レイヤード プロトコルと 1 つ以上のプロトコル チェーンをインストールできます。 WSCInstallProvider を使用して同じ作業を実行するには、複数の関数呼び出しが必要です。

Winsock 2 は、階層化されたプロトコルに対応します。 階層化されたプロトコルは、リモート エンドポイントとのデータの実際の交換に基づくトランスポート スタックに依存しながら、より高いレベルの通信機能のみを実装するプロトコルです。 レイヤー化されたプロトコルの例としては、認証を実行し、相互に合意された暗号化スキームを確立するために、接続確立プロセスにプロトコルを追加するセキュリティ層があります。 このようなセキュリティ プロトコルでは、一般に、TCP や SPX などの基になる信頼性の高いトランスポート プロトコルのサービスが必要になります。 基本プロトコルという用語は、リモート エンドポイントとのデータ通信を実行できる TCP や SPX などのプロトコルを指します。 階層化プロトコルという用語は、スタンドアロンにできないプロトコルを記述するために使用されます。 その後、プロトコル チェーンは、1 つ以上の階層化されたプロトコルとして定義され、ベース プロトコルによって連結され、固定されます。 基本プロトコルには、WSAProtocol_Info 構造体の ChainLen メンバーが BASE_PROTOCOL に設定され、1 に定義されています。 階層化プロトコルでは、WSAPROTOCOL_INFO構造体の ChainLen メンバーが LAYERED_PROTOCOL に設定され、ゼロとして定義されます。 プロトコル チェーンには、WSAPROTOCOL_INFO構造体の ChainLen メンバーが 1 より大きく設定されています。

lpProtocolInfoListNULL に設定されている場合、この関数はプロトコル チェーンを作成します。プロバイダーは、アドレス ファミリ、ソケットの種類、プロトコルで定義されている一意のプロトコルの種類ごとにベース プロトコルを介して階層化されます。 これにより、アクセスできない重複するプロバイダー エントリが作成されなくなります。

lpProtocolInfoListNULL 以外の値に設定されている場合、この関数は、指定された配列内の各要素からアドレス ファミリ、ソケットの種類、プロトコルに一致する構成情報の最上位のエントリを取得することによってプロトコル チェーンを作成します。 ここでも、アドレス ファミリ、ソケットの種類、プロトコルのみが考慮されます。他のすべてのメンバーと重複は無視されます。

この呼び出しが正常に完了すると、 WSAEnumProtocols または WSCEnumProtocols への後続の呼び出しでは、新しく作成されたプロトコル チェーン エントリが返されます。 Windows 環境では、WSCInstallProviderAndChains が正常に完了した後に WSAStartup を呼び出して作成された Ws_32.dllのインスタンスにのみ、WSAEnumProtocols と WSCEnumProtocols が返されるときに新しいエントリが含まれること注意してください。

メモWSAEnumProtocols 関数は、WSCEnumProtocols が行っている間、階層化されたプロトコル エントリを列挙しません。

 

成功すると、 WSCInstallProviderAndChains、WSAProviderConfigChange を呼び出して、変更の通知を登録したすべての関心のあるアプリケーションにアラートを送信しようとします。

WSCInstallProviderAndChains 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。 Administrators グループのメンバーではないユーザーが WSCInstallProviderAndChains を呼び出すと、関数呼び出しは失敗し、lpErrno パラメーターでWSANO_RECOVERYが返されます。 Windows Vista または Windows Server 2008 を実行しているコンピューターの場合、ユーザー アカウント制御 (UAC) が原因でこの関数が失敗する可能性もあります。 この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、 requestedExecutionLevelrequireAdministrator に設定されたマニフェスト ファイルでアプリケーションがマークされていない限り、この呼び出しは失敗します。 Windows Vista または Windows Server 2008 上のアプリケーションにこのマニフェスト ファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーは、この関数を成功させるために、拡張シェルで組み込みの Administrator (RunAs 管理者) としてアプリケーションを実行する必要があります。

ファイルのインストールまたはプロバイダー固有の構成は、呼び出し元のアプリケーションによって実行する必要があります。

要件

要件
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ws2spi.h
Library Ws2_32.lib
[DLL] Ws2_32.dll

こちらもご覧ください

LoadLibrary

トランスポートの構成とインストール

トランスポート サービス プロバイダー

WSAEnumProtocols

WSAProviderConfigChange

WSAStartup

WSCEnumProtocols

WSCInstallProvider

WSCWriteProviderOrder