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

WSCDeinstallProvider

関数
指定したトランスポートプロバイダーを登録解除する。
DLLWS2_32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT WSCDeinstallProvider(
    GUID* lpProviderId,
    INT* lpErrno
);

パラメーター

名前方向説明
lpProviderIdGUID*inプロバイダーのグローバル一意識別子 (GUID) へのポインターです。この値は各 WSAProtocol_Info 構造体内に格納されます。
lpErrnoINT*out関数が失敗した場合のエラーコードへのポインターです。

戻り値の型: INT

公式ドキュメント

指定されたトランスポートプロバイダーをシステム構成データベースから削除します。

戻り値

エラーが発生しなかった場合、 WSCDeinstallProvider はゼロを返します。それ以外の場合は SOCKET_ERROR を返し、具体的なエラーコードが lpErrno で取得できます。

エラーコード 意味
WSAEINVAL
lpProviderId パラメーターが有効なプロバイダーを指定していません。
WSAEFAULT
lpErrno パラメーターがユーザーアドレス空間の有効な部分にありません。
WSANO_RECOVERY
回復不可能なエラーが発生しました。このエラーは、ユーザーが Windows Sockets レジストリへの書き込みに必要な管理者特権を持っていない場合や、カタログエントリを開く際に失敗した場合など、いくつかの条件で返されます。
WSA_NOT_ENOUGH_MEMORY
利用可能なメモリが不足していました。このエラーは、新しいカタログエントリを割り当てるための十分なメモリがない場合に返されます。

解説(Remarks)

WSCDeinstallProvider 関数は、指定されたプロバイダーに関する共通の Windows Sockets 2 構成情報を削除します。このルーチンが正常に完了すると、レジストリに格納されている構成情報が変更されます。ただし、現在メモリ内にある Ws2_32.dll のインスタンスはこの変更を認識できません。

成功した場合、WSCDeinstallProviderWSAProviderConfigChange を呼び出すことにより、変更の通知を登録しているすべての関連アプリケーションへの通知を試みます。

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

Windows Vista または Windows Server 2008 を実行しているコンピューターでは、ユーザーアカウント制御 (UAC) が原因でこの関数が失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外で Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイル内で requestedExecutionLevelrequireAdministrator に設定されていない限り、この呼び出しは失敗します。Windows Vista または Windows Server 2008 上のアプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外で Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込みの Administrator として拡張シェル内 (RunAs 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 WSCDeinstallProvider(
    GUID* lpProviderId,
    INT* lpErrno
);
[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCDeinstallProvider(
    ref Guid lpProviderId,   // GUID*
    out int lpErrno   // INT* out
);
<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCDeinstallProvider(
    ByRef lpProviderId As Guid,   ' GUID*
    <Out> ByRef lpErrno As Integer   ' INT* out
) As Integer
End Function
' lpProviderId : GUID*
' lpErrno : INT* out
Declare PtrSafe Function WSCDeinstallProvider Lib "ws2_32" ( _
    ByVal lpProviderId As LongPtr, _
    ByRef lpErrno As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSCDeinstallProvider = ctypes.windll.ws2_32.WSCDeinstallProvider
WSCDeinstallProvider.restype = ctypes.c_int
WSCDeinstallProvider.argtypes = [
    ctypes.c_void_p,  # lpProviderId : GUID*
    ctypes.POINTER(ctypes.c_int),  # lpErrno : INT* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSCDeinstallProvider = ws2_32.NewProc("WSCDeinstallProvider")
)

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

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

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

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

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

関連項目

類似 API
公式の関連項目