ホーム › Networking.WinSock › WSAGetServiceClassNameByClassIdA

WSAGetServiceClassNameByClassIdA

関数

クラスIDから対応するサービスクラス名を取得する。

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

シグネチャ

// WS2_32.dll  (ANSI / -A)
#include <windows.h>

INT WSAGetServiceClassNameByClassIdA(
    GUID* lpServiceClassId,
    LPSTR lpszServiceClassName,
    DWORD* lpdwBufferLength
);

パラメーター

名前	型	方向	説明
lpServiceClassId	GUID*	in	サービスクラスの GUID へのポインターです。
lpszServiceClassName	LPSTR	out	サービス名へのポインターです。
lpdwBufferLength	DWORD*	inout	入力時には、lpszServiceClassName によって返されるバッファーの長さ(文字数)です。出力時には、lpszServiceClassName にコピーされたサービス名の長さ(文字数)です。

戻り値の型: INT

公式ドキュメント

WSAGetServiceClassNameByClassId 関数は、指定された型に関連付けられたサービスの名前を取得します。この名前は、FTP や SNA のような汎用的なサービス名であり、そのサービスの特定のインスタンスの名前ではありません。(ANSI)

戻り値

WSAGetServiceClassNameByClassId 関数は、成功した場合は値 0 を返します。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラー番号を取得できます。

エラーコード	意味
WSA_INVALID_PARAMETER	指定された lpServiceClassId パラメーターが無効です。
WSA_NOT_ENOUGH_MEMORY	操作を実行するのに十分なメモリがありませんでした。
WSAEACCES	呼び出し元のルーチンに、この情報へアクセスするための十分な権限がありません。
WSAEFAULT	lpszServiceClassName が指すバッファーが小さすぎます。より大きなバッファーを渡してください。
WSAENOBUFS	利用可能なバッファー領域がありません。
WSAEOPNOTSUPP	参照されているオブジェクトの型に対して、この操作はサポートされていません。このエラーは、サービスクラス情報の取得をサポートしない一部の名前空間プロバイダーによって返されます。
WSANO_DATA	lpServiceClassId は有効ですが、要求された型のデータが見つかりませんでした。
WSANOTINITIALISED	WS2_32.DLL が初期化されていません。アプリケーションは、Windows ソケット関数を呼び出す前に、まず WSAStartup を呼び出す必要があります。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

// WS2_32.dll  (ANSI / -A)
#include <windows.h>

INT WSAGetServiceClassNameByClassIdA(
    GUID* lpServiceClassId,
    LPSTR lpszServiceClassName,
    DWORD* lpdwBufferLength
);

[DllImport("WS2_32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int WSAGetServiceClassNameByClassIdA(
    ref Guid lpServiceClassId,   // GUID*
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszServiceClassName,   // LPSTR out
    ref uint lpdwBufferLength   // DWORD* in/out
);

<DllImport("WS2_32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAGetServiceClassNameByClassIdA(
    ByRef lpServiceClassId As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPStr)> lpszServiceClassName As System.Text.StringBuilder,   ' LPSTR out
    ByRef lpdwBufferLength As UInteger   ' DWORD* in/out
) As Integer
End Function

' lpServiceClassId : GUID*
' lpszServiceClassName : LPSTR out
' lpdwBufferLength : DWORD* in/out
Declare PtrSafe Function WSAGetServiceClassNameByClassIdA Lib "ws2_32" ( _
    ByVal lpServiceClassId As LongPtr, _
    ByVal lpszServiceClassName As String, _
    ByRef lpdwBufferLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSAGetServiceClassNameByClassIdA = ctypes.windll.ws2_32.WSAGetServiceClassNameByClassIdA
WSAGetServiceClassNameByClassIdA.restype = ctypes.c_int
WSAGetServiceClassNameByClassIdA.argtypes = [
    ctypes.c_void_p,  # lpServiceClassId : GUID*
    wintypes.LPSTR,  # lpszServiceClassName : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAGetServiceClassNameByClassIdA = Fiddle::Function.new(
  lib['WSAGetServiceClassNameByClassIdA'],
  [
    Fiddle::TYPE_VOIDP,  # lpServiceClassId : GUID*
    Fiddle::TYPE_VOIDP,  # lpszServiceClassName : LPSTR out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("WS2_32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int WSAGetServiceClassNameByClassIdA(ref Guid lpServiceClassId, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszServiceClassName, ref uint lpdwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAGetServiceClassNameByClassIdA' -Namespace Win32 -PassThru
# $api::WSAGetServiceClassNameByClassIdA(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)

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

出力引数:

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