ホーム › Networking.WinSock › WSCEnumNameSpaceProviders32

WSCEnumNameSpaceProviders32

関数

32ビットカタログの名前空間プロバイダを列挙する。

DLLWS2_32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT WSCEnumNameSpaceProviders32(
    DWORD* lpdwBufferLength,
    WSANAMESPACE_INFOW* lpnspBuffer
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

利用可能な 32 ビットのネームスペースプロバイダーに関する情報を返します。注意この呼び出しは、64 ビットプラットフォーム上で使用するための WSAEnumNameSpaceProviders の厳密な 32 ビット版です。64 ビットプロセスが 32 ビットのカタログにアクセスできるようにするために提供されています。

戻り値

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

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

解説(Remarks)

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

「隠された」ネームスペースプロバイダーという概念は存在しないため、この 32 ビット SPI 関数はネイティブ API 関数(WSAEnumNameSpaceProviders)と等価です。

WSCEnumNameSpaceProviders32 関数は Unicode 専用の関数であり、WSANAMESPACE_INFOEXW 構造体を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WSCEnumNameSpaceProviders32(
    DWORD* lpdwBufferLength,
    WSANAMESPACE_INFOW* lpnspBuffer
);

[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCEnumNameSpaceProviders32(
    ref uint lpdwBufferLength,   // DWORD* in/out
    IntPtr lpnspBuffer   // WSANAMESPACE_INFOW* out
);

<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCEnumNameSpaceProviders32(
    ByRef lpdwBufferLength As UInteger,   ' DWORD* in/out
    lpnspBuffer As IntPtr   ' WSANAMESPACE_INFOW* out
) As Integer
End Function

' lpdwBufferLength : DWORD* in/out
' lpnspBuffer : WSANAMESPACE_INFOW* out
Declare PtrSafe Function WSCEnumNameSpaceProviders32 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

WSCEnumNameSpaceProviders32 = ctypes.windll.ws2_32.WSCEnumNameSpaceProviders32
WSCEnumNameSpaceProviders32.restype = ctypes.c_int
WSCEnumNameSpaceProviders32.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
    ctypes.c_void_p,  # lpnspBuffer : WSANAMESPACE_INFOW* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSCEnumNameSpaceProviders32 = Fiddle::Function.new(
  lib['WSCEnumNameSpaceProviders32'],
  [
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpnspBuffer : WSANAMESPACE_INFOW* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSCEnumNameSpaceProviders32(
        lpdwBufferLength: *mut u32,  // DWORD* in/out
        lpnspBuffer: *mut WSANAMESPACE_INFOW  // WSANAMESPACE_INFOW* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll")]
public static extern int WSCEnumNameSpaceProviders32(ref uint lpdwBufferLength, IntPtr lpnspBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSCEnumNameSpaceProviders32' -Namespace Win32 -PassThru
# $api::WSCEnumNameSpaceProviders32(lpdwBufferLength, lpnspBuffer)

#uselib "WS2_32.dll"
#func global WSCEnumNameSpaceProviders32 "WSCEnumNameSpaceProviders32" sptr, sptr
; WSCEnumNameSpaceProviders32 varptr(lpdwBufferLength), varptr(lpnspBuffer)   ; 戻り値は stat
; lpdwBufferLength : DWORD* in/out -> "sptr"
; lpnspBuffer : WSANAMESPACE_INFOW* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSCEnumNameSpaceProviders32 "WSCEnumNameSpaceProviders32" var, var
; res = WSCEnumNameSpaceProviders32(lpdwBufferLength, lpnspBuffer)
; lpdwBufferLength : DWORD* in/out -> "var"
; lpnspBuffer : WSANAMESPACE_INFOW* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSCEnumNameSpaceProviders32 "WSCEnumNameSpaceProviders32" sptr, sptr
; res = WSCEnumNameSpaceProviders32(varptr(lpdwBufferLength), varptr(lpnspBuffer))
; lpdwBufferLength : DWORD* in/out -> "sptr"
; lpnspBuffer : WSANAMESPACE_INFOW* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。