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

WSCEnumNameSpaceProvidersEx32

関数
32ビットカタログの名前空間プロバイダを拡張形式で列挙する。
DLLWS2_32.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT WSCEnumNameSpaceProvidersEx32(
    DWORD* lpdwBufferLength,
    WSANAMESPACE_INFOEXW* lpnspBuffer
);

パラメーター

名前型方向説明
lpdwBufferLengthDWORD*inout入力時には、lpnspBuffer が指すバッファに格納されているバイト数を指定します。出力時には(関数が失敗し、エラーが WSAEFAULT の場合)、要求されたすべての情報を取得するために lpnspBuffer バッファに割り当てる必要がある最小バイト数が返されます。WSCEnumNameSpaceProvidersEx32 に渡すバッファは、すべての名前空間情報を保持できる十分な大きさである必要があります。
lpnspBufferWSANAMESPACE_INFOEXW*outWSANAMESPACE_INFOEXW 構造体が格納されるバッファです。返される構造体はバッファの先頭に連続して配置されます。構造体内のポインターが参照する可変サイズの情報は、固定サイズ構造体の末尾とバッファの末尾との間のバッファ内の位置を指します。格納された構造体の数は WSCEnumNameSpaceProvidersEx32 の戻り値となります。

戻り値の型: INT

公式ドキュメント

利用可能な 32 ビットの名前空間プロバイダーに関する情報を取得します。

戻り値

WSCEnumNameSpaceProvidersEx32 関数は、lpnspBuffer にコピーされた WSANAMESPACE_INFOEXW 構造体の数を返します。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラー番号を取得できます。

エラーコード 意味
WSAEFAULT
 バッファ長が、関連するすべての WSANAMESPACE_INFOEXW 構造体と関連情報を受け取るには小さすぎたか、または lpnspBuffer パラメーターが **NULL** ポインターでした。このエラーが返される場合、必要なバッファ長が lpdwBufferLength パラメーターに返されます。
WSANOTINITIALISED
 WS2_32.DLL が初期化されていません。アプリケーションは、Windows Sockets 関数を呼び出す前に、まず WSAStartup を呼び出す必要があります。
WSA_NOT_ENOUGH_MEMORY
 操作を実行するためのメモリが不足していました。

解説(Remarks)

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

現在、Windows に含まれる名前空間のうち、WSANAMESPACE_INFOEXW 構造体の ProviderSpecific メンバー内の情報を使用する唯一の名前空間は、NS_EMAIL 名前空間の名前空間プロバイダーです。NS_EMAIL 名前空間プロバイダーの ProviderSpecific メンバーの形式は、NAPI_PROVIDER_INSTALLATION_BLOB 構造体です。

"隠し" 名前空間プロバイダーという概念は存在しないため、この 32 ビット SPI 関数はネイティブ API 関数(WSAEnumNameSpaceProvidersEx)と同等です。

WSCInstallNameSpaceEx32 関数の lpProviderInfo パラメーターに渡された名前空間エントリに関連付けられたプロバイダー固有のデータ blob は、WSCEnumNameSpaceProvidersEx32 関数を使用して照会できます。

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

WSCEnumNameSpaceProvidersEx32 = ctypes.windll.ws2_32.WSCEnumNameSpaceProvidersEx32
WSCEnumNameSpaceProvidersEx32.restype = ctypes.c_int
WSCEnumNameSpaceProvidersEx32.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
    ctypes.c_void_p,  # lpnspBuffer : WSANAMESPACE_INFOEXW* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSCEnumNameSpaceProvidersEx32 = ws2_32.NewProc("WSCEnumNameSpaceProvidersEx32")
)

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

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

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

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

let wscenumnamespaceprovidersex32 =
  foreign "WSCEnumNameSpaceProvidersEx32"
    ((ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* lpdwBufferLength : DWORD* in/out -> (ptr uint32_t) *)
(* lpnspBuffer : WSANAMESPACE_INFOEXW* out -> (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 ("WSCEnumNameSpaceProvidersEx32" wscenum-name-space-providers-ex32 :convention :stdcall) :int32
  (lpdw-buffer-length :pointer)   ; DWORD* in/out
  (lpnsp-buffer :pointer))   ; WSANAMESPACE_INFOEXW* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSCEnumNameSpaceProvidersEx32 = Win32::API::More->new('WS2_32',
    'int WSCEnumNameSpaceProvidersEx32(LPVOID lpdwBufferLength, LPVOID lpnspBuffer)');
# my $ret = $WSCEnumNameSpaceProvidersEx32->Call($lpdwBufferLength, $lpnspBuffer);
# lpdwBufferLength : DWORD* in/out -> LPVOID
# lpnspBuffer : WSANAMESPACE_INFOEXW* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型