ホーム › Networking.WinSock › WSAInstallServiceClassW

WSAInstallServiceClassW

関数

新しいサービスクラス情報を登録する。

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

シグネチャ

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

INT WSAInstallServiceClassW(
    WSASERVICECLASSINFOW* lpServiceClassInfo
);

パラメーター

名前	型	方向	説明
lpServiceClassInfo	WSASERVICECLASSINFOW*	in	サービスクラスから名前空間固有の型へのマッピング情報です。一度に複数のマッピングを処理できます。関連するデータ構造の説明については、サービスクラスのデータ構造のセクションを参照してください。

名前

型

方向

説明

lpServiceClassInfo

WSASERVICECLASSINFOW*

サービスクラスから名前空間固有の型へのマッピング情報です。一度に複数のマッピングを処理できます。

関連するデータ構造の説明については、サービスクラスのデータ構造のセクションを参照してください。

戻り値の型: INT

公式ドキュメント

WSAInstallServiceClass 関数は、名前空間内にサービスクラススキーマを登録します。(Unicode)

戻り値

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

エラーコード	意味
WSA_INVALID_PARAMETER	名前空間プロバイダーが、要求されたクラス情報を提供できません。
WSA_NOT_ENOUGH_MEMORY	操作を実行するためのメモリが不足していました。
WSAEACCES	呼び出し元の関数に、サービスをインストールするための十分な権限がありません。
WSAEALREADY	このサービスクラス識別子に対するサービスクラス情報は、すでに登録されています。サービスクラス情報を変更するには、まず WSARemoveServiceClass を使用し、その後、更新したクラス情報データで再インストールしてください。
WSAEINVAL	サービスクラス情報が無効、または不適切に構成されていました。このエラーは、lpServiceClassInfo パラメーターが NULL の場合に返されます。
WSAEOPNOTSUPP	操作はサポートされていません。このエラーは、名前空間プロバイダーがこの関数を実装していない場合に返されます。
WSANO_DATA	要求された名前は有効ですが、要求された型のデータが見つかりませんでした。
WSANOTINITIALISED	WS2_32.DLL が初期化されていません。アプリケーションは、Windows Sockets の関数を呼び出す前に、まず WSAStartup を呼び出す必要があります。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WSAInstallServiceClassW(
    WSASERVICECLASSINFOW* lpServiceClassInfo
);

[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int WSAInstallServiceClassW(
    IntPtr lpServiceClassInfo   // WSASERVICECLASSINFOW*
);

<DllImport("WS2_32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAInstallServiceClassW(
    lpServiceClassInfo As IntPtr   ' WSASERVICECLASSINFOW*
) As Integer
End Function

' lpServiceClassInfo : WSASERVICECLASSINFOW*
Declare PtrSafe Function WSAInstallServiceClassW Lib "ws2_32" ( _
    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

WSAInstallServiceClassW = ctypes.windll.ws2_32.WSAInstallServiceClassW
WSAInstallServiceClassW.restype = ctypes.c_int
WSAInstallServiceClassW.argtypes = [
    ctypes.c_void_p,  # lpServiceClassInfo : WSASERVICECLASSINFOW*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAInstallServiceClassW = Fiddle::Function.new(
  lib['WSAInstallServiceClassW'],
  [
    Fiddle::TYPE_VOIDP,  # lpServiceClassInfo : WSASERVICECLASSINFOW*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "ws2_32")]
extern "system" {
    fn WSAInstallServiceClassW(
        lpServiceClassInfo: *mut WSASERVICECLASSINFOW  // WSASERVICECLASSINFOW*
    ) -> 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 WSAInstallServiceClassW(IntPtr lpServiceClassInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAInstallServiceClassW' -Namespace Win32 -PassThru
# $api::WSAInstallServiceClassW(lpServiceClassInfo)

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

出力引数:

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