ホーム › Networking.WinSock › WSAGetServiceClassInfoW

WSAGetServiceClassInfoW

関数

サービスクラスのスキーマ情報を取得する。

DLLWS2_32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WS2_32.dll  (Unicode / -W)
#include <windows.h>

INT WSAGetServiceClassInfoW(
    GUID* lpProviderId,
    GUID* lpServiceClassId,
    DWORD* lpdwBufSize,
    WSASERVICECLASSINFOW* lpServiceClassInfo
);

パラメーター

名前	型	方向	説明
lpProviderId	GUID*	in	特定のネームスペースプロバイダーを識別する GUID へのポインターです。
lpServiceClassId	GUID*	in	サービスクラスを識別する GUID へのポインターです。
lpdwBufSize	DWORD*	inout	入力時には、lpServiceClassInfo パラメーターが指すバッファーに含まれるバイト数を指定します。出力時には、関数が失敗し、エラーが WSAEFAULT であった場合、このパラメーターはレコードを取得するために lpServiceClassInfo が指すバッファーに必要な最小サイズ(バイト単位)を指定します。
lpServiceClassInfo	WSASERVICECLASSINFOW*	out	指定されたサービスクラスについて、対象のネームスペースプロバイダーから取得したサービスクラス情報を格納する WSASERVICECLASSINFO 構造体へのポインターです。

戻り値の型: INT

公式ドキュメント

WSAGetServiceClassInfo 関数は、指定されたネームスペースプロバイダーから、指定されたサービスクラスに関するクラス情報(スキーマ)を取得します。(Unicode)

戻り値

WSAGetServiceClassInfo が成功した場合、戻り値は 0 です。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで特定のエラー番号を取得できます。

エラーコード	意味
WSA_NOT_ENOUGH_MEMORY	操作を実行するためのメモリが不足していました。
WSAEACCES	呼び出し元のルーチンには、その情報にアクセスするための十分な権限がありません。
WSAEFAULT	lpServiceClassInfo パラメーターが指すバッファーが小さすぎて WSASERVICECLASSINFOW を格納できません。アプリケーションはより大きなバッファーを渡す必要があります。
WSAEINVAL	指定されたサービスクラス識別子またはネームスペースプロバイダー識別子が無効です。lpProviderId、lpServiceClassId、lpdwBufSize、または lpServiceClassInfo パラメーターが NULL の場合に、このエラーが返されます。
WSAEOPNOTSUPP	参照されているオブジェクトの種類ではこの操作はサポートされていません。このエラーは、サービスクラス情報の取得をサポートしていない一部のネームスペースプロバイダーによって返されます。
WSANO_DATA	要求された名前は有効ですが、要求された種類のデータが見つかりませんでした。
WSANOTINITIALISED	WS2_32.DLL が初期化されていません。アプリケーションは、いずれかの Windows Sockets 関数を呼び出す前に、まず WSAStartup を呼び出す必要があります。
WSATYPE_NOT_FOUND	指定されたクラスが見つかりませんでした。

解説(Remarks)

WSAGetServiceClassInfo 関数は、ネームスペースプロバイダーからサービスクラス情報を取得します。特定のネームスペースプロバイダーから取得されるサービスクラス情報は、そのサービスクラスがインストールされたときに指定されたクラス情報の完全な集合であるとは限りません。個々のネームスペースプロバイダーは、自身がサポートするネームスペースに該当するサービスクラス情報のみを保持すればよいことになっています。詳細については、サービスクラスのデータ構造のセクションを参照してください。

メモ

winsock2.h ヘッダーは WSAGetServiceClassInfo をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// WS2_32.dll  (Unicode / -W)
#include <windows.h>

INT WSAGetServiceClassInfoW(
    GUID* lpProviderId,
    GUID* lpServiceClassId,
    DWORD* lpdwBufSize,
    WSASERVICECLASSINFOW* lpServiceClassInfo
);

[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int WSAGetServiceClassInfoW(
    ref Guid lpProviderId,   // GUID*
    ref Guid lpServiceClassId,   // GUID*
    ref uint lpdwBufSize,   // DWORD* in/out
    IntPtr lpServiceClassInfo   // WSASERVICECLASSINFOW* out
);

<DllImport("WS2_32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAGetServiceClassInfoW(
    ByRef lpProviderId As Guid,   ' GUID*
    ByRef lpServiceClassId As Guid,   ' GUID*
    ByRef lpdwBufSize As UInteger,   ' DWORD* in/out
    lpServiceClassInfo As IntPtr   ' WSASERVICECLASSINFOW* out
) As Integer
End Function

' lpProviderId : GUID*
' lpServiceClassId : GUID*
' lpdwBufSize : DWORD* in/out
' lpServiceClassInfo : WSASERVICECLASSINFOW* out
Declare PtrSafe Function WSAGetServiceClassInfoW Lib "ws2_32" ( _
    ByVal lpProviderId As LongPtr, _
    ByVal lpServiceClassId As LongPtr, _
    ByRef lpdwBufSize As Long, _
    ByVal lpServiceClassInfo As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSAGetServiceClassInfoW = ctypes.windll.ws2_32.WSAGetServiceClassInfoW
WSAGetServiceClassInfoW.restype = ctypes.c_int
WSAGetServiceClassInfoW.argtypes = [
    ctypes.c_void_p,  # lpProviderId : GUID*
    ctypes.c_void_p,  # lpServiceClassId : GUID*
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufSize : DWORD* in/out
    ctypes.c_void_p,  # lpServiceClassInfo : WSASERVICECLASSINFOW* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAGetServiceClassInfoW = Fiddle::Function.new(
  lib['WSAGetServiceClassInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # lpProviderId : GUID*
    Fiddle::TYPE_VOIDP,  # lpServiceClassId : GUID*
    Fiddle::TYPE_VOIDP,  # lpdwBufSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpServiceClassInfo : WSASERVICECLASSINFOW* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "ws2_32")]
extern "system" {
    fn WSAGetServiceClassInfoW(
        lpProviderId: *mut GUID,  // GUID*
        lpServiceClassId: *mut GUID,  // GUID*
        lpdwBufSize: *mut u32,  // DWORD* in/out
        lpServiceClassInfo: *mut WSASERVICECLASSINFOW  // WSASERVICECLASSINFOW* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int WSAGetServiceClassInfoW(ref Guid lpProviderId, ref Guid lpServiceClassId, ref uint lpdwBufSize, IntPtr lpServiceClassInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAGetServiceClassInfoW' -Namespace Win32 -PassThru
# $api::WSAGetServiceClassInfoW(lpProviderId, lpServiceClassId, lpdwBufSize, lpServiceClassInfo)

#uselib "WS2_32.dll"
#func global WSAGetServiceClassInfoW "WSAGetServiceClassInfoW" wptr, wptr, wptr, wptr
; WSAGetServiceClassInfoW varptr(lpProviderId), varptr(lpServiceClassId), varptr(lpdwBufSize), varptr(lpServiceClassInfo)   ; 戻り値は stat
; lpProviderId : GUID* -> "wptr"
; lpServiceClassId : GUID* -> "wptr"
; lpdwBufSize : DWORD* in/out -> "wptr"
; lpServiceClassInfo : WSASERVICECLASSINFOW* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSAGetServiceClassInfoW "WSAGetServiceClassInfoW" var, var, var, var
; res = WSAGetServiceClassInfoW(lpProviderId, lpServiceClassId, lpdwBufSize, lpServiceClassInfo)
; lpProviderId : GUID* -> "var"
; lpServiceClassId : GUID* -> "var"
; lpdwBufSize : DWORD* in/out -> "var"
; lpServiceClassInfo : WSASERVICECLASSINFOW* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSAGetServiceClassInfoW "WSAGetServiceClassInfoW" sptr, sptr, sptr, sptr
; res = WSAGetServiceClassInfoW(varptr(lpProviderId), varptr(lpServiceClassId), varptr(lpdwBufSize), varptr(lpServiceClassInfo))
; lpProviderId : GUID* -> "sptr"
; lpServiceClassId : GUID* -> "sptr"
; lpdwBufSize : DWORD* in/out -> "sptr"
; lpServiceClassInfo : WSASERVICECLASSINFOW* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。