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

WSCEnableNSProvider32

関数
32ビットカタログの名前空間プロバイダの有効無効を切り替える。
DLLWS2_32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT WSCEnableNSProvider32(
    GUID* lpProviderId,
    BOOL fEnable
);

パラメーター

名前方向説明
lpProviderIdGUID*in名前空間プロバイダーのグローバル一意識別子 (GUID) へのポインター。
fEnableBOOLinBoolean 値。TRUE の場合、名前空間プロバイダーはアクティブ状態に設定されます。FALSE の場合、名前空間プロバイダーは無効になり、クエリ操作やサービス登録に使用できなくなります。

戻り値の型: INT

公式ドキュメント

指定された32ビットの名前空間プロバイダーを有効または無効にします。

戻り値

エラーが発生しなかった場合、 WSCEnableNSProvider32 関数は NO_ERROR (ゼロ) を返します。それ以外の場合、関数が失敗すると SOCKET_ERROR を返し、 WSAGetLastError 関数を使用して適切なエラーコードを取得する必要があります。

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

解説(Remarks)

WSCEnableNSProvider32 関数は、名前空間プロバイダーの状態を変更するために使用することを目的としています。独立系ソフトウェアベンダー (ISV) は通常、自身のプロバイダーをアクティブ化するために、別の ISV の名前空間プロバイダーを無効化すべきではありません。その選択はユーザーに委ねるべきです。

WSCEnableNSProvider32 は、WSCEnableNSProvider の厳密な32ビット版です。64ビットコンピューターでは、特に32ビット用ではないすべての呼び出し (たとえば、末尾が "32" で終わらないすべての関数) は、ネイティブな64ビットカタログに対して動作します。64ビットコンピューター上で実行されるプロセスは、厳密な32ビットカタログに対して操作し、互換性を保つために、専用の32ビット関数呼び出しを使用する必要があります。専用の32ビット呼び出しの定義とセマンティクスは、対応するネイティブ版と同じです。

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

WSCEnableNSProvider32 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。Administrators グループのメンバーでないユーザーが WSCEnableNSProvider32 を呼び出した場合、関数呼び出しは失敗します。

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 WSCEnableNSProvider32(
    GUID* lpProviderId,
    BOOL fEnable
);
[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCEnableNSProvider32(
    ref Guid lpProviderId,   // GUID*
    bool fEnable   // BOOL
);
<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCEnableNSProvider32(
    ByRef lpProviderId As Guid,   ' GUID*
    fEnable As Boolean   ' BOOL
) As Integer
End Function
' lpProviderId : GUID*
' fEnable : BOOL
Declare PtrSafe Function WSCEnableNSProvider32 Lib "ws2_32" ( _
    ByVal lpProviderId As LongPtr, _
    ByVal fEnable As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSCEnableNSProvider32 = ws2_32.NewProc("WSCEnableNSProvider32")
)

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

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

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

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

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

関連項目

類似 API