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

WSCUnInstallNameSpace

関数
名前空間プロバイダーを登録解除する。
DLLWS2_32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT WSCUnInstallNameSpace(
    GUID* lpProviderId
);

パラメーター

名前方向説明
lpProviderIdGUID*inアンインストールするネームスペースプロバイダーの GUID (globally unique identifier) へのポインター。

戻り値の型: INT

公式ドキュメント

指定されたネームスペースプロバイダーをアンインストールします。

戻り値

エラーが発生しない場合、 WSCUnInstallNameSpaceNO_ERROR (ゼロ) を返します。それ以外の場合、関数が失敗すると SOCKET_ERROR を返し、 WSAGetLastError 関数を使用して該当するエラーコードを取得する必要があります。

エラーコード 意味
WSAEFAULT
lpProviderId パラメーターが、ユーザーアドレス空間の有効な部分にないメモリを指しています。
WSAEINVAL
指定されたネームスペースプロバイダー識別子が無効です。
WSASYSCALLFAILURE
決して失敗しないはずのシステムコールが失敗しました。
WSA_NOT_ENOUGH_MEMORY
利用可能なメモリが不足していました。このエラーは、新しいカタログエントリを割り当てるのに十分なメモリがない場合に返されます。

解説(Remarks)

ネームスペース構成関数は、すでに実行中のアプリケーションには影響しません。新しくインストールされたネームスペースプロバイダーはアプリケーションから認識されず、ネームスペースプロバイダーの有効化状態の変更も反映されません。 WSCUnInstallNameSpace の呼び出し後に起動されたアプリケーションには、変更が反映されます。

成功すると、WSCUnInstallNameSpaceWSAProviderConfigChange を呼び出すことで、変更の通知を登録しているすべての関心のあるアプリケーションに通知を試みます。

WSCUnInstallNameSpace 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。Administrators グループのメンバーでないユーザーが WSCUnInstallNameSpace を呼び出した場合、関数呼び出しは失敗し、lpErrno パラメーターに WSANO_RECOVERY が返されます。

Windows Vista または Windows Server 2008 で実行されているコンピューターでは、この関数はユーザーアカウント制御 (UAC) のために失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevelrequireAdministrator に設定されていない限り、この呼び出しは失敗します。Windows Vista または Windows Server 2008 上のアプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込みの Administrator として拡張シェル (管理者として実行) でアプリケーションを実行する必要があります。

この関数の呼び出し元は、サービスプロバイダーを完全にアンインストールするために必要な追加ファイルやサービスプロバイダー固有の構成情報を削除する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WSCUnInstallNameSpace(
    GUID* lpProviderId
);
[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCUnInstallNameSpace(
    ref Guid lpProviderId   // GUID*
);
<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCUnInstallNameSpace(
    ByRef lpProviderId As Guid   ' GUID*
) As Integer
End Function
' lpProviderId : GUID*
Declare PtrSafe Function WSCUnInstallNameSpace Lib "ws2_32" ( _
    ByVal lpProviderId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSCUnInstallNameSpace = ctypes.windll.ws2_32.WSCUnInstallNameSpace
WSCUnInstallNameSpace.restype = ctypes.c_int
WSCUnInstallNameSpace.argtypes = [
    ctypes.c_void_p,  # lpProviderId : GUID*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSCUnInstallNameSpace = Fiddle::Function.new(
  lib['WSCUnInstallNameSpace'],
  [
    Fiddle::TYPE_VOIDP,  # lpProviderId : GUID*
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn WSCUnInstallNameSpace(
        lpProviderId: *mut GUID  // GUID*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll")]
public static extern int WSCUnInstallNameSpace(ref Guid lpProviderId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSCUnInstallNameSpace' -Namespace Win32 -PassThru
# $api::WSCUnInstallNameSpace(lpProviderId)
#uselib "WS2_32.dll"
#func global WSCUnInstallNameSpace "WSCUnInstallNameSpace" sptr
; WSCUnInstallNameSpace varptr(lpProviderId)   ; 戻り値は stat
; lpProviderId : GUID* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSCUnInstallNameSpace "WSCUnInstallNameSpace" var
; res = WSCUnInstallNameSpace(lpProviderId)
; lpProviderId : GUID* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSCUnInstallNameSpace(GUID* lpProviderId)
#uselib "WS2_32.dll"
#cfunc global WSCUnInstallNameSpace "WSCUnInstallNameSpace" var
; res = WSCUnInstallNameSpace(lpProviderId)
; lpProviderId : GUID* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSCUnInstallNameSpace = ws2_32.NewProc("WSCUnInstallNameSpace")
)

// lpProviderId (GUID*)
r1, _, err := procWSCUnInstallNameSpace.Call(
	uintptr(lpProviderId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSCUnInstallNameSpace(
  lpProviderId: PGUID   // GUID*
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSCUnInstallNameSpace';
result := DllCall("WS2_32\WSCUnInstallNameSpace"
    , "Ptr", lpProviderId   ; GUID*
    , "Int")   ; return: INT
●WSCUnInstallNameSpace(lpProviderId) = DLL("WS2_32.dll", "int WSCUnInstallNameSpace(void*)")
# 呼び出し: WSCUnInstallNameSpace(lpProviderId)
# lpProviderId : GUID* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn WSCUnInstallNameSpace(
    lpProviderId: [*c]GUID // GUID*
) callconv(std.os.windows.WINAPI) i32;
proc WSCUnInstallNameSpace(
    lpProviderId: ptr GUID  # GUID*
): int32 {.importc: "WSCUnInstallNameSpace", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int WSCUnInstallNameSpace(
    GUID* lpProviderId   // GUID*
);
ccall((:WSCUnInstallNameSpace, "WS2_32.dll"), stdcall, Int32,
      (Ptr{GUID},),
      lpProviderId)
# lpProviderId : GUID* -> Ptr{GUID}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSCUnInstallNameSpace(
    void* lpProviderId);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSCUnInstallNameSpace(lpProviderId)
-- lpProviderId : GUID*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSCUnInstallNameSpace = lib.func('__stdcall', 'WSCUnInstallNameSpace', 'int32_t', ['void *']);
// WSCUnInstallNameSpace(lpProviderId)
// lpProviderId : GUID* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSCUnInstallNameSpace: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.WSCUnInstallNameSpace(lpProviderId)
// lpProviderId : GUID* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSCUnInstallNameSpace(
    void* lpProviderId);
C, "WS2_32.dll");
// $ffi->WSCUnInstallNameSpace(lpProviderId);
// lpProviderId : GUID*
// 構造体/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);
    int WSCUnInstallNameSpace(
        Pointer lpProviderId   // GUID*
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSCUnInstallNameSpace = WSCUnInstallNameSpace(
    lpProviderId : GUID*   # GUID*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSCUnInstallNameSpaceNative = Int32 Function(Pointer<Void>);
typedef WSCUnInstallNameSpaceDart = int Function(Pointer<Void>);
final WSCUnInstallNameSpace = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSCUnInstallNameSpaceNative, WSCUnInstallNameSpaceDart>('WSCUnInstallNameSpace');
// lpProviderId : GUID* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSCUnInstallNameSpace(
  lpProviderId: PGUID   // GUID*
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSCUnInstallNameSpace';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSCUnInstallNameSpace"
  c_WSCUnInstallNameSpace :: Ptr () -> IO Int32
-- lpProviderId : GUID* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wscuninstallnamespace =
  foreign "WSCUnInstallNameSpace"
    ((ptr void) @-> returning int32_t)
(* lpProviderId : GUID* -> (ptr void) *)
(* 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 ("WSCUnInstallNameSpace" wscun-install-name-space :convention :stdcall) :int32
  (lp-provider-id :pointer))   ; GUID*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSCUnInstallNameSpace = Win32::API::More->new('WS2_32',
    'int WSCUnInstallNameSpace(LPVOID lpProviderId)');
# my $ret = $WSCUnInstallNameSpace->Call($lpProviderId);
# lpProviderId : GUID* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目