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

WSAEnumNameSpaceProvidersExA

関数
名前空間プロバイダーを拡張情報付きで列挙する。
DLLWS2_32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// WS2_32.dll  (ANSI / -A)
#include <windows.h>

INT WSAEnumNameSpaceProvidersExA(
    DWORD* lpdwBufferLength,
    WSANAMESPACE_INFOEXA* lpnspBuffer
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

利用可能なネームスペースプロバイダーに関する情報を取得します。(ANSI)

戻り値

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

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

解説(Remarks)

WSAEnumNameSpaceProvidersEx 関数は、WSAEnumNameSpaceProviders 関数の拡張版です。WSCInstallNameSpaceEx 関数の lpProviderInfo パラメーターに渡されたネームスペースエントリーに関連付けられたプロバイダー固有のデータ blob は、WSAEnumNameSpaceProvidersEx 関数を使用して照会できます。

現在のところ、Windows に同梱されているネームスペースプロバイダーのうち、WSANAMESPACE_INFOEX 構造体の ProviderSpecific メンバーに情報を設定する唯一のものは NS_EMAIL プロバイダーです。NS_EMAIL ネームスペースプロバイダーの ProviderSpecific メンバーの形式は NAPI_PROVIDER_INSTALLATION_BLOB 構造体です。

UNICODE または _UNICODE が定義されている場合、WSAEnumNameSpaceProvidersEx はこの関数の Unicode 版である WSAEnumNameSpaceProvidersExW として定義されます。lpnspBuffer パラメーターは LPSAWSANAMESPACE_INFOEXW データ型として定義され、成功時には WSANAMESPACE_INFOEXW 構造体が返されます。

UNICODE または _UNICODE が定義されていない場合、WSAEnumNameSpaceProvidersEx はこの関数の ANSI 版である WSAEnumNameSpaceProvidersExA として定義されます。lpnspBuffer パラメーターは LPSAWSANAMESPACE_INFOEXA データ型として定義され、成功時には WSANAMESPACE_INFOEXA 構造体が返されます。

Windows 8.1 および Windows Server 2012 R2: WSAEnumNameSpaceProvidersExW 関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。

メモ

winsock2.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WSAEnumNameSpaceProvidersEx を定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WS2_32.dll  (ANSI / -A)
#include <windows.h>

INT WSAEnumNameSpaceProvidersExA(
    DWORD* lpdwBufferLength,
    WSANAMESPACE_INFOEXA* lpnspBuffer
);
[DllImport("WS2_32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int WSAEnumNameSpaceProvidersExA(
    ref uint lpdwBufferLength,   // DWORD* in/out
    IntPtr lpnspBuffer   // WSANAMESPACE_INFOEXA* out
);
<DllImport("WS2_32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAEnumNameSpaceProvidersExA(
    ByRef lpdwBufferLength As UInteger,   ' DWORD* in/out
    lpnspBuffer As IntPtr   ' WSANAMESPACE_INFOEXA* out
) As Integer
End Function
' lpdwBufferLength : DWORD* in/out
' lpnspBuffer : WSANAMESPACE_INFOEXA* out
Declare PtrSafe Function WSAEnumNameSpaceProvidersExA 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

WSAEnumNameSpaceProvidersExA = ctypes.windll.ws2_32.WSAEnumNameSpaceProvidersExA
WSAEnumNameSpaceProvidersExA.restype = ctypes.c_int
WSAEnumNameSpaceProvidersExA.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
    ctypes.c_void_p,  # lpnspBuffer : WSANAMESPACE_INFOEXA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAEnumNameSpaceProvidersExA = ws2_32.NewProc("WSAEnumNameSpaceProvidersExA")
)

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

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

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

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

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

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型