ホーム › Networking.WinSock › WSCGetProviderInfo

WSCGetProviderInfo

関数

プロバイダーの追加情報を取得する。

DLLWS2_32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// WS2_32.dll
#include <windows.h>

INT WSCGetProviderInfo(
    GUID* lpProviderId,
    WSC_PROVIDER_INFO_TYPE InfoType,
    BYTE* Info,
    UINT_PTR* InfoSize,
    DWORD Flags,
    INT* lpErrno
);

パラメーター

名前	型	方向	説明
lpProviderId	GUID*	in	プロバイダーのグローバル一意識別子 (GUID) へのポインター。
InfoType	WSC_PROVIDER_INFO_TYPE	in	この LSP プロトコルエントリに対して要求される情報クラス。
Info	BYTE*	out	要求された LSP プロトコルエントリの情報クラスデータを受け取るバッファーへのポインター。このパラメーターが NULL の場合、WSCGetProviderInfo は失敗を返し、このバッファーに必要なサイズが InfoSize パラメーターに返されます。
InfoSize	UINT_PTR*	inout	Info パラメーターが指すバッファーのサイズ (バイト単位)。Info パラメーターが NULL の場合、WSCGetProviderInfo は失敗を返し、InfoSize パラメーターには必要なバッファーのサイズが格納されます。
Flags	DWORD	in	WSCGetProviderInfo 関数呼び出しの動作を変更するために使用するフラグ。
lpErrno	INT*	out	関数が失敗した場合のエラーコードへのポインター。

戻り値の型: INT

公式ドキュメント

レイヤードサービスプロバイダー (LSP) の情報クラスに関連付けられたデータを取得します。

戻り値

エラーが発生しない場合、WSCGetProviderInfo は ERROR_SUCCESS (ゼロ) を返します。それ以外の場合は SOCKET_ERROR を返し、特定のエラーコードが lpErrno パラメーターに返されます。

エラーコード	意味
ERROR_CALL_NOT_IMPLEMENTED	呼び出しが実装されていません。このエラーは、InfoType パラメーターに ProviderInfoAudit が指定された場合に返されます。
WSAEFAULT	1 つ以上の引数が、ユーザーアドレス空間の有効な部分にありません。
WSAEINVAL	1 つ以上の引数が無効です。
WSAEINVALIDPROVIDER	指定された lpProviderId に対するプロトコルエントリが見つかりませんでした。
WSANO_RECOVERY	回復不能なエラーが発生しました。このエラーは、ユーザーが Winsock レジストリへのアクセスに必要な管理者権限を持っていない、または Winsock カタログエントリを開く際に障害が発生した、などのいくつかの条件で返されます。
WSA_NOT_ENOUGH_MEMORY	使用可能なメモリが不足していました。このエラーは、新しいカタログエントリを割り当てるのに十分なメモリがない場合に返されます。

解説(Remarks)

WSCGetProviderInfo は、レイヤードサービスプロバイダーの情報クラスデータを取得するために使用されます。InfoType パラメーターに ProviderInfoLspCategories が設定されている場合、成功すると WSCGetProviderInfo は、LSP が実装する適切な LSP カテゴリフラグが設定された Info パラメーターを返します。

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

LSP の初期化中、LSP は多数の Winsock SPI 関数へのポインターを提供する必要があります。これらの関数は、通常の処理中に LSP の直上のレイヤー (別の LSP または Ws2_32.DLL) によって呼び出されます。

インストール可能ファイルシステム (IFS) を実装する LSP は、自身が実装する関数へのポインターを提供するか、LSP の直下のレイヤーによって提供されるポインターをそのまま返すかを選択的に選ぶことができます。非 IFS LSP は、独自のハンドルを提供するため、すべての Winsock SPI 関数を実装する必要があります。これは、各 SPI において、LSP が作成したすべてのソケットハンドルを下位プロバイダー (別の LSP またはベースプロトコル) のソケットハンドルにマッピングする必要があるためです。

ただし、すべての LSP は、Winsock SPI 関数のサブセットに対してのみ追加処理を行うことで、その固有の処理を実行します。

LSP が実装する SPI 関数のサブセットと、それらの各関数に対して実行される追加処理の性質に基づいて、LSP カテゴリを定義することが可能です。

LSP を分類し、さらに Winsock ソケットを使用するアプリケーションを分類することによって、実行時に特定のプロセスに LSP を関与させるべきかどうかを選択的に判断できるようになります。

Windows Vista 以降では、Windows Sockets の呼び出しおよびデータとどのように相互作用するかに基づいて LSP を分類できます。LSP カテゴリとは、Winsock SPI 関数のサブセットに対する識別可能な動作のグループです。たとえば、HTTP コンテンツフィルターはデータインスペクター (LSP_INSPECTOR カテゴリ) として分類されます。LSP_INSPECTOR カテゴリは、データ転送 SPI 関数のパラメーターを検査します (ただし変更はしません)。アプリケーションは LSP のカテゴリを照会し、LSP カテゴリとアプリケーションが許可する LSP カテゴリのセットに基づいて、その LSP をロードしないことを選択できます。

次の表は、LSP を分類できるカテゴリの一覧です。

LSP カテゴリ	説明
LSP_CRYPTO_COMPRESS	LSP は暗号化またはデータ圧縮のプロバイダーです。
LSP_FIREWALL	LSP はファイアウォールプロバイダーです。
LSP_LOCAL_CACHE	LSP はローカルキャッシュプロバイダーです。
LSP_INBOUND_MODIFY	LSP は受信データを変更します。
LSP_INSPECTOR	LSP はデータを検査またはフィルタリングします。
LSP_OUTBOUND_MODIFY	LSP は送信データを変更します。
LSP_PROXY	LSP はプロキシとして機能し、パケットをリダイレクトします。
LSP_REDIRECTOR	LSP はネットワークリダイレクターです。
LSP_SYSTEM	LSP はサービスおよびシステムプロセスでの使用に適しています。

1 つの LSP が複数のカテゴリに属する場合があります。たとえば、ファイアウォール/セキュリティ LSP は、インスペクター (LSP_INSPECTOR) とファイアウォール (LSP_FIREWALL) の両方のカテゴリに属する可能性があります。

LSP にカテゴリが設定されていない場合、それは All Other カテゴリにあると見なされます。この LSP カテゴリは、サービスやシステムプロセス (例: lsass、winlogon、多くの svchost プロセス) ではロードされません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WS2_32.dll
#include <windows.h>

INT WSCGetProviderInfo(
    GUID* lpProviderId,
    WSC_PROVIDER_INFO_TYPE InfoType,
    BYTE* Info,
    UINT_PTR* InfoSize,
    DWORD Flags,
    INT* lpErrno
);

[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCGetProviderInfo(
    ref Guid lpProviderId,   // GUID*
    int InfoType,   // WSC_PROVIDER_INFO_TYPE
    IntPtr Info,   // BYTE* out
    ref UIntPtr InfoSize,   // UINT_PTR* in/out
    uint Flags,   // DWORD
    out int lpErrno   // INT* out
);

<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCGetProviderInfo(
    ByRef lpProviderId As Guid,   ' GUID*
    InfoType As Integer,   ' WSC_PROVIDER_INFO_TYPE
    Info As IntPtr,   ' BYTE* out
    ByRef InfoSize As UIntPtr,   ' UINT_PTR* in/out
    Flags As UInteger,   ' DWORD
    <Out> ByRef lpErrno As Integer   ' INT* out
) As Integer
End Function

' lpProviderId : GUID*
' InfoType : WSC_PROVIDER_INFO_TYPE
' Info : BYTE* out
' InfoSize : UINT_PTR* in/out
' Flags : DWORD
' lpErrno : INT* out
Declare PtrSafe Function WSCGetProviderInfo Lib "ws2_32" ( _
    ByVal lpProviderId As LongPtr, _
    ByVal InfoType As Long, _
    ByVal Info As LongPtr, _
    ByRef InfoSize As LongPtr, _
    ByVal Flags As Long, _
    ByRef lpErrno As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSCGetProviderInfo = ctypes.windll.ws2_32.WSCGetProviderInfo
WSCGetProviderInfo.restype = ctypes.c_int
WSCGetProviderInfo.argtypes = [
    ctypes.c_void_p,  # lpProviderId : GUID*
    ctypes.c_int,  # InfoType : WSC_PROVIDER_INFO_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # Info : BYTE* out
    ctypes.POINTER(ctypes.c_size_t),  # InfoSize : UINT_PTR* in/out
    wintypes.DWORD,  # Flags : DWORD
    ctypes.POINTER(ctypes.c_int),  # lpErrno : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSCGetProviderInfo = Fiddle::Function.new(
  lib['WSCGetProviderInfo'],
  [
    Fiddle::TYPE_VOIDP,  # lpProviderId : GUID*
    Fiddle::TYPE_INT,  # InfoType : WSC_PROVIDER_INFO_TYPE
    Fiddle::TYPE_VOIDP,  # Info : BYTE* out
    Fiddle::TYPE_VOIDP,  # InfoSize : UINT_PTR* in/out
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # lpErrno : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSCGetProviderInfo(
        lpProviderId: *mut GUID,  // GUID*
        InfoType: i32,  // WSC_PROVIDER_INFO_TYPE
        Info: *mut u8,  // BYTE* out
        InfoSize: *mut usize,  // UINT_PTR* in/out
        Flags: u32,  // DWORD
        lpErrno: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll")]
public static extern int WSCGetProviderInfo(ref Guid lpProviderId, int InfoType, IntPtr Info, ref UIntPtr InfoSize, uint Flags, out int lpErrno);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSCGetProviderInfo' -Namespace Win32 -PassThru
# $api::WSCGetProviderInfo(lpProviderId, InfoType, Info, InfoSize, Flags, lpErrno)

#uselib "WS2_32.dll"
#func global WSCGetProviderInfo "WSCGetProviderInfo" sptr, sptr, sptr, sptr, sptr, sptr
; WSCGetProviderInfo varptr(lpProviderId), InfoType, varptr(Info), varptr(InfoSize), Flags, varptr(lpErrno)   ; 戻り値は stat
; lpProviderId : GUID* -> "sptr"
; InfoType : WSC_PROVIDER_INFO_TYPE -> "sptr"
; Info : BYTE* out -> "sptr"
; InfoSize : UINT_PTR* in/out -> "sptr"
; Flags : DWORD -> "sptr"
; lpErrno : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSCGetProviderInfo "WSCGetProviderInfo" var, int, var, var, int, var
; res = WSCGetProviderInfo(lpProviderId, InfoType, Info, InfoSize, Flags, lpErrno)
; lpProviderId : GUID* -> "var"
; InfoType : WSC_PROVIDER_INFO_TYPE -> "int"
; Info : BYTE* out -> "var"
; InfoSize : UINT_PTR* in/out -> "var"
; Flags : DWORD -> "int"
; lpErrno : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSCGetProviderInfo "WSCGetProviderInfo" sptr, int, sptr, sptr, int, sptr
; res = WSCGetProviderInfo(varptr(lpProviderId), InfoType, varptr(Info), varptr(InfoSize), Flags, varptr(lpErrno))
; lpProviderId : GUID* -> "sptr"
; InfoType : WSC_PROVIDER_INFO_TYPE -> "int"
; Info : BYTE* out -> "sptr"
; InfoSize : UINT_PTR* in/out -> "sptr"
; Flags : DWORD -> "int"
; lpErrno : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。