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

WSCWriteNameSpaceOrder32

関数
32ビットカタログの名前空間プロバイダ並び順を書き込む。
DLLWS2_32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT WSCWriteNameSpaceOrder32(
    GUID* lpProviderId,
    DWORD dwNumberOfEntries
);

パラメーター

名前方向説明
lpProviderIdGUID*inoutWSANAMESPACE_INFO 構造体に含まれる NSProviderId 要素の配列です。NSProviderId 要素の順序が、名前空間プロバイダーの新しい 優先順位の並び順になります。
dwNumberOfEntriesDWORDinNSProviderId 配列内の要素数です。

戻り値の型: INT

公式ドキュメント

32 ビットカタログ内で利用可能な Windows Sockets (Winsock) 2 名前空間プロバイダーの順序を変更します。

戻り値

ルーチンが成功した場合、この関数は ERROR_SUCCESS (ゼロ) を返します。それ以外の場合は、特定のエラーコードを返します。

エラーコード 意味
WSAEFAULT
NSProviderId 配列がプロセスのアドレス空間内に完全には収まっていません。
WSAEINVAL
入力パラメーターが無効であったため、何も処理は行われませんでした。
WSANO_RECOVERY
回復不能なエラーが発生しました。このエラーは、次のような複数の条件下で返されます。Winsock レジストリを開けなかった、Winsock レジストリへの書き込みに必要な管理者権限がユーザーにない、または別のアプリケーションが現在名前空間プロバイダーカタログに書き込み中である、などです。
WSASYSCALLFAILURE
決して失敗しないはずのシステムコールが失敗しました。
WSATRY_AGAIN
この関数が別のスレッドまたはプロセスによって呼び出されています。
WSA_NOT_ENOUGH_MEMORY
操作を実行するのに十分なメモリがありませんでした。
(その他)
この関数は任意のレジストリエラーコードを返す可能性があります。

解説(Remarks)

64 ビットプラットフォームでは、名前空間プロバイダーは WSCInstallNameSpace32 関数を使用して 32 ビット名前空間プロバイダーカタログにインストールされます。32 ビットカタログ内で名前空間プロバイダーが最初にインストールされる順序が、 WSCEnumNameSpaceProviders32 によって列挙される際の既定の順序を決定します。さらに重要なことに、この順序は、クライアントが名前解決を要求したときに名前空間プロバイダーが検討される順序も決定します。64 ビットプラットフォームでは、64 ビットプロセスが 32 ビット名前空間プロバイダーカタログ内の名前空間プロバイダーの順序を変更できるように、WSCWriteNameSpaceOrder32 関数が用意されています。ネイティブカタログ内の名前空間プロバイダーの順序は、WSCWriteNameSpaceOrder 関数を使用して変更できます。

現在の名前空間プロバイダーカタログは、次のレジストリキーの下にレジストリに格納されています。HKEY_LOCAL_MACHINE\SYSTEM\Current Control Set\Services\Winsock2\Parameters\NameSpace_Catalog5

クライアントによる名前解決の要求では、WSALookupServiceBeginWSALookupServiceNext、および WSALookupServiceEnd ルーチンが使用されます。WSALookupServiceBegin に渡される WSAQUERYSET 構造体の dwNameSpace メンバーには、検索を制約する単一の名前空間の識別子 (たとえば NS_DNS) を設定するか、すべての名前空間を含める場合は NS_ALL を設定します。複数の名前空間プロバイダーが特定の名前空間 (たとえば NS_DNS) をサポートしている場合、lpNSProviderId メンバーが特定の名前空間プロバイダーに設定されていない限り、要求された dwNameSpace に一致するすべての名前空間プロバイダーからの結果が返されます。dwNameSpace メンバーに NS_ALL が指定された場合は、すべての名前空間プロバイダーからの結果が返されます。結果が返される順序は、カタログ内の名前空間プロバイダーの順序によって決まります。

Windows SDK には、インストールされている名前空間プロバイダーのカタログを表示できる SpOrder.exe というアプリケーションが含まれています。Winsock 2 には、64 ビットプラットフォーム上で 32 ビット名前空間プロバイダーカタログ内の名前空間プロバイダーの順序を変更するための WSCWriteNameSpaceOrder32 関数をエクスポートする ws2_32.DLL が含まれています。このインターフェイスは WS2_32.lib をリンクすることでインポートできます。Windows XP Service Pack 2 (SP2) および Windows Server 2003 Service Pack 1 (SP1) 以降を実行しているコンピューターでは、netsh.exe winsock show catalog コマンドにより、インストールされているプロトコルプロバイダーと名前空間プロバイダーの両方が表示されます。最初にネイティブ 64 ビットカタログが表示され、続いて 32 ビットプロバイダーカタログが表示されます (名前の後に 32 が付いて区別されます)。

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

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

次のリストは、 WSCWriteNameSpaceOrder32 関数が失敗する可能性のあるシナリオを示しています。

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

WSCWriteNameSpaceOrder32 = ctypes.windll.ws2_32.WSCWriteNameSpaceOrder32
WSCWriteNameSpaceOrder32.restype = ctypes.c_int
WSCWriteNameSpaceOrder32.argtypes = [
    ctypes.c_void_p,  # lpProviderId : GUID* in/out
    wintypes.DWORD,  # dwNumberOfEntries : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSCWriteNameSpaceOrder32 = ws2_32.NewProc("WSCWriteNameSpaceOrder32")
)

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

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

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

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

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

関連項目

類似 API
公式の関連項目