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

WSCWriteProviderOrder32

関数
32ビットカタログのプロバイダ並び順を書き込む。
DLLWS2_32.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT WSCWriteProviderOrder32(
    DWORD* lpwdCatalogEntryId,
    DWORD dwNumberOfEntries
);

パラメーター

名前型方向説明
lpwdCatalogEntryIdDWORD*inoutWSAPROTOCOL_INFO 構造体に含まれる CatalogEntryId 要素の配列へのポインター。CatalogEntryId 要素の並び順が、プロトコルの新しい優先順位になります。
dwNumberOfEntriesDWORDinlpwdCatalogEntryId 配列内の要素数。

戻り値の型: INT

公式ドキュメント

利用可能な 32 ビットトランスポートプロバイダーの順序を変更するために使用します。

戻り値

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

エラーコード 意味
WSAEINVAL
 1 つ以上の引数が無効であり、処理は行われませんでした。
WSANO_RECOVERY
 回復不能なエラーが発生しました。このエラーは、ユーザーに Winsock レジストリへの書き込みに必要な管理者権限がない、またはカタログエントリのオープンや書き込み時に障害が発生したなど、いくつかの条件下で返されます。
WSA_NOT_ENOUGH_MEMORY
 利用可能なメモリが不足していました。このエラーは、新しいカタログエントリを割り当てるのに十分なメモリがない場合に返されます。
(その他)
 このルーチンは、任意のレジストリエラーコードを返す可能性があります。

解説(Remarks)

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

トランスポートサービスプロバイダーが最初にインストールされる順序によって、サービスプロバイダーインターフェイスでの WSCEnumProtocols32 またはアプリケーションインターフェイスでの WSAEnumProtocols を通じて列挙される順序が決まります。さらに重要な点として、この順序は、クライアントがアドレスファミリー、種類、プロトコル識別子に基づいて socket の作成を要求した際に、プロトコルおよびサービスプロバイダーが考慮される順序も決定します。

Windows Sockets 2 には Sporder.exe というアプリケーションが含まれており、プロトコルがすでにインストールされた後に、インストール済みプロトコルのカタログを対話的に並べ替えることができます。また、Windows Sockets 2 には補助 DLL の Sporder.dll も含まれており、プロトコルを並べ替えるためのこのプロシージャルインターフェイスをエクスポートします。このインターフェイスは Sporder.lib とリンクすることでインポートできます。

WSCWriteProviderOrder32 関数が失敗する可能性があるシナリオは次のとおりです。

成功すると、WSCWriteProviderOrder32 は WSAProviderConfigChange を呼び出して、変更の通知を登録しているすべての関連アプリケーションに警告しようとします。

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

WSCWriteProviderOrder32 = ctypes.windll.ws2_32.WSCWriteProviderOrder32
WSCWriteProviderOrder32.restype = ctypes.c_int
WSCWriteProviderOrder32.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpwdCatalogEntryId : DWORD* in/out
    wintypes.DWORD,  # dwNumberOfEntries : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSCWriteProviderOrder32 = ws2_32.NewProc("WSCWriteProviderOrder32")
)

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

extern "ws2_32" fn WSCWriteProviderOrder32(
    lpwdCatalogEntryId: [*c]u32, // DWORD* in/out
    dwNumberOfEntries: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc WSCWriteProviderOrder32(
    lpwdCatalogEntryId: ptr uint32,  # DWORD* in/out
    dwNumberOfEntries: uint32  # DWORD
): int32 {.importc: "WSCWriteProviderOrder32", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int WSCWriteProviderOrder32(
    uint* lpwdCatalogEntryId,   // DWORD* in/out
    uint dwNumberOfEntries   // DWORD
);
ccall((:WSCWriteProviderOrder32, "WS2_32.dll"), stdcall, Int32,
      (Ptr{UInt32}, UInt32),
      lpwdCatalogEntryId, dwNumberOfEntries)
# lpwdCatalogEntryId : DWORD* in/out -> Ptr{UInt32}
# dwNumberOfEntries : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSCWriteProviderOrder32(
    uint32_t* lpwdCatalogEntryId,
    uint32_t dwNumberOfEntries);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSCWriteProviderOrder32(lpwdCatalogEntryId, dwNumberOfEntries)
-- lpwdCatalogEntryId : DWORD* in/out
-- dwNumberOfEntries : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSCWriteProviderOrder32 = lib.func('__stdcall', 'WSCWriteProviderOrder32', 'int32_t', ['uint32_t *', 'uint32_t']);
// WSCWriteProviderOrder32(lpwdCatalogEntryId, dwNumberOfEntries)
// lpwdCatalogEntryId : DWORD* in/out -> 'uint32_t *'
// dwNumberOfEntries : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSCWriteProviderOrder32: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.WSCWriteProviderOrder32(lpwdCatalogEntryId, dwNumberOfEntries)
// lpwdCatalogEntryId : DWORD* in/out -> "pointer"
// dwNumberOfEntries : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSCWriteProviderOrder32(
    uint32_t* lpwdCatalogEntryId,
    uint32_t dwNumberOfEntries);
C, "WS2_32.dll");
// $ffi->WSCWriteProviderOrder32(lpwdCatalogEntryId, dwNumberOfEntries);
// lpwdCatalogEntryId : DWORD* 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 WSCWriteProviderOrder32(
        IntByReference lpwdCatalogEntryId,   // DWORD* in/out
        int dwNumberOfEntries   // DWORD
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSCWriteProviderOrder32 = WSCWriteProviderOrder32(
    lpwdCatalogEntryId : UInt32*,   # DWORD* 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 WSCWriteProviderOrder32Native = Int32 Function(Pointer<Uint32>, Uint32);
typedef WSCWriteProviderOrder32Dart = int Function(Pointer<Uint32>, int);
final WSCWriteProviderOrder32 = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSCWriteProviderOrder32Native, WSCWriteProviderOrder32Dart>('WSCWriteProviderOrder32');
// lpwdCatalogEntryId : DWORD* in/out -> Pointer<Uint32>
// dwNumberOfEntries : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSCWriteProviderOrder32(
  lpwdCatalogEntryId: Pointer;   // DWORD* in/out
  dwNumberOfEntries: DWORD   // DWORD
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSCWriteProviderOrder32';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

類似 API
公式の関連項目