Win32 API 日本語リファレンス
ホームNetworking.WinSock › WSAGetServiceClassNameByClassIdW

WSAGetServiceClassNameByClassIdW

関数
クラスIDから対応するサービスクラス名を取得する。
DLLWS2_32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT WSAGetServiceClassNameByClassIdW(
    GUID* lpServiceClassId,
    LPWSTR lpszServiceClassName,
    DWORD* lpdwBufferLength
);

パラメーター

名前方向説明
lpServiceClassIdGUID*inサービスクラスの GUID へのポインター。
lpszServiceClassNameLPWSTRoutサービス名へのポインター。
lpdwBufferLengthDWORD*inout入力時には、lpszServiceClassName で返されるバッファーの長さ(文字数)。出力時には、lpszServiceClassName にコピーされたサービス名の長さ(文字数)。

戻り値の型: INT

公式ドキュメント

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

戻り値

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 Sockets 関数を呼び出す前に、まず 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  (Unicode / -W)
#include <windows.h>

INT WSAGetServiceClassNameByClassIdW(
    GUID* lpServiceClassId,
    LPWSTR lpszServiceClassName,
    DWORD* lpdwBufferLength
);
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int WSAGetServiceClassNameByClassIdW(
    ref Guid lpServiceClassId,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszServiceClassName,   // LPWSTR out
    ref uint lpdwBufferLength   // DWORD* in/out
);
<DllImport("WS2_32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAGetServiceClassNameByClassIdW(
    ByRef lpServiceClassId As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> lpszServiceClassName As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpdwBufferLength As UInteger   ' DWORD* in/out
) As Integer
End Function
' lpServiceClassId : GUID*
' lpszServiceClassName : LPWSTR out
' lpdwBufferLength : DWORD* in/out
Declare PtrSafe Function WSAGetServiceClassNameByClassIdW Lib "ws2_32" ( _
    ByVal lpServiceClassId As LongPtr, _
    ByVal lpszServiceClassName As LongPtr, _
    ByRef lpdwBufferLength As Long) 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

WSAGetServiceClassNameByClassIdW = ctypes.windll.ws2_32.WSAGetServiceClassNameByClassIdW
WSAGetServiceClassNameByClassIdW.restype = ctypes.c_int
WSAGetServiceClassNameByClassIdW.argtypes = [
    ctypes.c_void_p,  # lpServiceClassId : GUID*
    wintypes.LPWSTR,  # lpszServiceClassName : LPWSTR 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')
WSAGetServiceClassNameByClassIdW = Fiddle::Function.new(
  lib['WSAGetServiceClassNameByClassIdW'],
  [
    Fiddle::TYPE_VOIDP,  # lpServiceClassId : GUID*
    Fiddle::TYPE_VOIDP,  # lpszServiceClassName : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "ws2_32")]
extern "system" {
    fn WSAGetServiceClassNameByClassIdW(
        lpServiceClassId: *mut GUID,  // GUID*
        lpszServiceClassName: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern int WSAGetServiceClassNameByClassIdW(ref Guid lpServiceClassId, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszServiceClassName, ref uint lpdwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAGetServiceClassNameByClassIdW' -Namespace Win32 -PassThru
# $api::WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
#uselib "WS2_32.dll"
#func global WSAGetServiceClassNameByClassIdW "WSAGetServiceClassNameByClassIdW" wptr, wptr, wptr
; WSAGetServiceClassNameByClassIdW varptr(lpServiceClassId), varptr(lpszServiceClassName), varptr(lpdwBufferLength)   ; 戻り値は stat
; lpServiceClassId : GUID* -> "wptr"
; lpszServiceClassName : LPWSTR out -> "wptr"
; lpdwBufferLength : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSAGetServiceClassNameByClassIdW "WSAGetServiceClassNameByClassIdW" var, var, var
; res = WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
; lpServiceClassId : GUID* -> "var"
; lpszServiceClassName : LPWSTR out -> "var"
; lpdwBufferLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSAGetServiceClassNameByClassIdW(GUID* lpServiceClassId, LPWSTR lpszServiceClassName, DWORD* lpdwBufferLength)
#uselib "WS2_32.dll"
#cfunc global WSAGetServiceClassNameByClassIdW "WSAGetServiceClassNameByClassIdW" var, var, var
; res = WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
; lpServiceClassId : GUID* -> "var"
; lpszServiceClassName : LPWSTR out -> "var"
; lpdwBufferLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAGetServiceClassNameByClassIdW = ws2_32.NewProc("WSAGetServiceClassNameByClassIdW")
)

// lpServiceClassId (GUID*), lpszServiceClassName (LPWSTR out), lpdwBufferLength (DWORD* in/out)
r1, _, err := procWSAGetServiceClassNameByClassIdW.Call(
	uintptr(lpServiceClassId),
	uintptr(lpszServiceClassName),
	uintptr(lpdwBufferLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSAGetServiceClassNameByClassIdW(
  lpServiceClassId: PGUID;   // GUID*
  lpszServiceClassName: PWideChar;   // LPWSTR out
  lpdwBufferLength: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSAGetServiceClassNameByClassIdW';
result := DllCall("WS2_32\WSAGetServiceClassNameByClassIdW"
    , "Ptr", lpServiceClassId   ; GUID*
    , "Ptr", lpszServiceClassName   ; LPWSTR out
    , "Ptr", lpdwBufferLength   ; DWORD* in/out
    , "Int")   ; return: INT
●WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength) = DLL("WS2_32.dll", "int WSAGetServiceClassNameByClassIdW(void*, char*, void*)")
# 呼び出し: WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
# lpServiceClassId : GUID* -> "void*"
# lpszServiceClassName : LPWSTR out -> "char*"
# lpdwBufferLength : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "ws2_32" fn WSAGetServiceClassNameByClassIdW(
    lpServiceClassId: [*c]GUID, // GUID*
    lpszServiceClassName: [*c]u16, // LPWSTR out
    lpdwBufferLength: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WSAGetServiceClassNameByClassIdW(
    lpServiceClassId: ptr GUID,  # GUID*
    lpszServiceClassName: ptr uint16,  # LPWSTR out
    lpdwBufferLength: ptr uint32  # DWORD* in/out
): int32 {.importc: "WSAGetServiceClassNameByClassIdW", stdcall, dynlib: "WS2_32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ws2_32");
extern(Windows)
int WSAGetServiceClassNameByClassIdW(
    GUID* lpServiceClassId,   // GUID*
    wchar* lpszServiceClassName,   // LPWSTR out
    uint* lpdwBufferLength   // DWORD* in/out
);
ccall((:WSAGetServiceClassNameByClassIdW, "WS2_32.dll"), stdcall, Int32,
      (Ptr{GUID}, Ptr{UInt16}, Ptr{UInt32}),
      lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
# lpServiceClassId : GUID* -> Ptr{GUID}
# lpszServiceClassName : LPWSTR out -> Ptr{UInt16}
# lpdwBufferLength : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSAGetServiceClassNameByClassIdW(
    void* lpServiceClassId,
    uint16_t* lpszServiceClassName,
    uint32_t* lpdwBufferLength);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
-- lpServiceClassId : GUID*
-- lpszServiceClassName : LPWSTR out
-- lpdwBufferLength : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSAGetServiceClassNameByClassIdW = lib.func('__stdcall', 'WSAGetServiceClassNameByClassIdW', 'int32_t', ['void *', 'uint16_t *', 'uint32_t *']);
// WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
// lpServiceClassId : GUID* -> 'void *'
// lpszServiceClassName : LPWSTR out -> 'uint16_t *'
// lpdwBufferLength : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSAGetServiceClassNameByClassIdW: { parameters: ["pointer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength)
// lpServiceClassId : GUID* -> "pointer"
// lpszServiceClassName : LPWSTR out -> "buffer"
// lpdwBufferLength : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSAGetServiceClassNameByClassIdW(
    void* lpServiceClassId,
    uint16_t* lpszServiceClassName,
    uint32_t* lpdwBufferLength);
C, "WS2_32.dll");
// $ffi->WSAGetServiceClassNameByClassIdW(lpServiceClassId, lpszServiceClassName, lpdwBufferLength);
// lpServiceClassId : GUID*
// lpszServiceClassName : LPWSTR out
// lpdwBufferLength : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class, W32APIOptions.UNICODE_OPTIONS);
    int WSAGetServiceClassNameByClassIdW(
        Pointer lpServiceClassId,   // GUID*
        char[] lpszServiceClassName,   // LPWSTR out
        IntByReference lpdwBufferLength   // DWORD* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ws2_32")]
lib LibWS2_32
  fun WSAGetServiceClassNameByClassIdW = WSAGetServiceClassNameByClassIdW(
    lpServiceClassId : GUID*,   # GUID*
    lpszServiceClassName : UInt16*,   # LPWSTR out
    lpdwBufferLength : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSAGetServiceClassNameByClassIdWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Uint32>);
typedef WSAGetServiceClassNameByClassIdWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Uint32>);
final WSAGetServiceClassNameByClassIdW = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSAGetServiceClassNameByClassIdWNative, WSAGetServiceClassNameByClassIdWDart>('WSAGetServiceClassNameByClassIdW');
// lpServiceClassId : GUID* -> Pointer<Void>
// lpszServiceClassName : LPWSTR out -> Pointer<Utf16>
// lpdwBufferLength : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSAGetServiceClassNameByClassIdW(
  lpServiceClassId: PGUID;   // GUID*
  lpszServiceClassName: PWideChar;   // LPWSTR out
  lpdwBufferLength: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSAGetServiceClassNameByClassIdW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSAGetServiceClassNameByClassIdW"
  c_WSAGetServiceClassNameByClassIdW :: Ptr () -> CWString -> Ptr Word32 -> IO Int32
-- lpServiceClassId : GUID* -> Ptr ()
-- lpszServiceClassName : LPWSTR out -> CWString
-- lpdwBufferLength : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsagetserviceclassnamebyclassidw =
  foreign "WSAGetServiceClassNameByClassIdW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* lpServiceClassId : GUID* -> (ptr void) *)
(* lpszServiceClassName : LPWSTR out -> (ptr uint16_t) *)
(* lpdwBufferLength : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("WSAGetServiceClassNameByClassIdW" wsaget-service-class-name-by-class-id-w :convention :stdcall) :int32
  (lp-service-class-id :pointer)   ; GUID*
  (lpsz-service-class-name :pointer)   ; LPWSTR out
  (lpdw-buffer-length :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSAGetServiceClassNameByClassIdW = Win32::API::More->new('WS2_32',
    'int WSAGetServiceClassNameByClassIdW(LPVOID lpServiceClassId, LPWSTR lpszServiceClassName, LPVOID lpdwBufferLength)');
# my $ret = $WSAGetServiceClassNameByClassIdW->Call($lpServiceClassId, $lpszServiceClassName, $lpdwBufferLength);
# lpServiceClassId : GUID* -> LPVOID
# lpszServiceClassName : LPWSTR out -> LPWSTR
# lpdwBufferLength : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目