ホーム › Networking.WinSock › WSCInstallNameSpace32

WSCInstallNameSpace32

関数

32ビットカタログに名前空間プロバイダをインストールする。

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

シグネチャ

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

INT WSCInstallNameSpace32(
    LPWSTR lpszIdentifier,
    LPWSTR lpszPathName,
    DWORD dwNameSpace,
    DWORD dwVersion,
    GUID* lpProviderId
);

パラメーター

名前	型	方向	説明
lpszIdentifier	LPWSTR	in	lpProviderId パラメーターで渡されるグローバル一意識別子 (GUID) に関連付けられたプロバイダーを識別する文字列へのポインター。
lpszPathName	LPWSTR	in	プロバイダーの DLL イメージへのパスを含む文字列へのポインター。この文字列は通常のパス解決規則に従います。すなわち、このパスには埋め込みの環境文字列 (%SystemRoot% など) を含めることができます。このような環境文字列は、WS2_32.DLL がアプリケーションに代わってプロバイダー DLL を後でロードする必要が生じたときに展開されます。埋め込みの環境文字列が展開された後、Ws2_32.dll は得られた文字列を LoadLibrary 関数に渡してプロバイダーをメモリにロードします。詳細については LoadLibrary を参照してください。
dwNameSpace	DWORD	in	このプロバイダーがサポートするネームスペースを指定する記述子。
dwVersion	DWORD	in	プロバイダーのバージョン番号を指定する記述子。
lpProviderId	GUID*	in	このプロバイダーの一意の識別子。この GUID は Uuidgen.exe で生成する必要があります。

戻り値の型: INT

公式ドキュメント

指定された 32 ビットのネームスペースプロバイダーをインストールします。(WSCInstallNamespace32)

戻り値

エラーが発生しなかった場合、 WSCInstallNameSpace32 関数は NO_ERROR (ゼロ) を返します。それ以外の場合、関数が失敗すると SOCKET_ERROR を返し、 WSAGetLastError 関数を使用して適切なエラーコードを取得する必要があります。

エラーコード	意味
WSAEACCES	呼び出し元のルーチンに、ネームスペースをインストールするための十分な権限がありません。
WSAEINVAL	1 つ以上の引数が無効です。
WSANO_RECOVERY	回復不能なエラーが発生しました。このエラーは次のようないくつかの条件下で返されます。プロバイダーが既にインストールされている、Winsock レジストリへの書き込みに必要な管理者権限がユーザーにない、またはカタログエントリの作成もしくはインストール時に障害が発生した場合などです。
WSASYSCALLFAILURE	決して失敗しないはずのシステムコールが失敗しました。
WSA_NOT_ENOUGH_MEMORY	使用可能なメモリが不足していました。このエラーは、新しいカタログエントリを割り当てるのに十分なメモリがない場合に返されます。

解説(Remarks)

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

ネームスペース構成関数は、既に実行中のアプリケーションには影響しません。新しくインストールされたネームスペースプロバイダーはアプリケーションから認識されず、ネームスペースプロバイダーの有効化状態の変更も認識されません。 WSCInstallNameSpace32 の呼び出し後に起動されたアプリケーションは、その変更を認識します。

WSCInstallNameSpace32 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出せます。WSCInstallNameSpace32 が Administrators グループのメンバーでないユーザーによって呼び出された場合、この関数呼び出しは失敗します。 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 WSCInstallNameSpace32(
    LPWSTR lpszIdentifier,
    LPWSTR lpszPathName,
    DWORD dwNameSpace,
    DWORD dwVersion,
    GUID* lpProviderId
);

[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCInstallNameSpace32(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszIdentifier,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszPathName,   // LPWSTR
    uint dwNameSpace,   // DWORD
    uint dwVersion,   // DWORD
    ref Guid lpProviderId   // GUID*
);

<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCInstallNameSpace32(
    <MarshalAs(UnmanagedType.LPWStr)> lpszIdentifier As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszPathName As String,   ' LPWSTR
    dwNameSpace As UInteger,   ' DWORD
    dwVersion As UInteger,   ' DWORD
    ByRef lpProviderId As Guid   ' GUID*
) As Integer
End Function

' lpszIdentifier : LPWSTR
' lpszPathName : LPWSTR
' dwNameSpace : DWORD
' dwVersion : DWORD
' lpProviderId : GUID*
Declare PtrSafe Function WSCInstallNameSpace32 Lib "ws2_32" ( _
    ByVal lpszIdentifier As LongPtr, _
    ByVal lpszPathName As LongPtr, _
    ByVal dwNameSpace As Long, _
    ByVal dwVersion As Long, _
    ByVal lpProviderId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSCInstallNameSpace32 = ctypes.windll.ws2_32.WSCInstallNameSpace32
WSCInstallNameSpace32.restype = ctypes.c_int
WSCInstallNameSpace32.argtypes = [
    wintypes.LPCWSTR,  # lpszIdentifier : LPWSTR
    wintypes.LPCWSTR,  # lpszPathName : LPWSTR
    wintypes.DWORD,  # dwNameSpace : DWORD
    wintypes.DWORD,  # dwVersion : DWORD
    ctypes.c_void_p,  # lpProviderId : GUID*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSCInstallNameSpace32 = Fiddle::Function.new(
  lib['WSCInstallNameSpace32'],
  [
    Fiddle::TYPE_VOIDP,  # lpszIdentifier : LPWSTR
    Fiddle::TYPE_VOIDP,  # lpszPathName : LPWSTR
    -Fiddle::TYPE_INT,  # dwNameSpace : DWORD
    -Fiddle::TYPE_INT,  # dwVersion : DWORD
    Fiddle::TYPE_VOIDP,  # lpProviderId : GUID*
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSCInstallNameSpace32(
        lpszIdentifier: *mut u16,  // LPWSTR
        lpszPathName: *mut u16,  // LPWSTR
        dwNameSpace: u32,  // DWORD
        dwVersion: u32,  // DWORD
        lpProviderId: *mut GUID  // GUID*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll")]
public static extern int WSCInstallNameSpace32([MarshalAs(UnmanagedType.LPWStr)] string lpszIdentifier, [MarshalAs(UnmanagedType.LPWStr)] string lpszPathName, uint dwNameSpace, uint dwVersion, ref Guid lpProviderId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSCInstallNameSpace32' -Namespace Win32 -PassThru
# $api::WSCInstallNameSpace32(lpszIdentifier, lpszPathName, dwNameSpace, dwVersion, lpProviderId)

#uselib "WS2_32.dll"
#func global WSCInstallNameSpace32 "WSCInstallNameSpace32" sptr, sptr, sptr, sptr, sptr
; WSCInstallNameSpace32 lpszIdentifier, lpszPathName, dwNameSpace, dwVersion, varptr(lpProviderId)   ; 戻り値は stat
; lpszIdentifier : LPWSTR -> "sptr"
; lpszPathName : LPWSTR -> "sptr"
; dwNameSpace : DWORD -> "sptr"
; dwVersion : DWORD -> "sptr"
; lpProviderId : GUID* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSCInstallNameSpace32 "WSCInstallNameSpace32" wstr, wstr, int, int, var
; res = WSCInstallNameSpace32(lpszIdentifier, lpszPathName, dwNameSpace, dwVersion, lpProviderId)
; lpszIdentifier : LPWSTR -> "wstr"
; lpszPathName : LPWSTR -> "wstr"
; dwNameSpace : DWORD -> "int"
; dwVersion : DWORD -> "int"
; lpProviderId : GUID* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSCInstallNameSpace32 "WSCInstallNameSpace32" wstr, wstr, int, int, sptr
; res = WSCInstallNameSpace32(lpszIdentifier, lpszPathName, dwNameSpace, dwVersion, varptr(lpProviderId))
; lpszIdentifier : LPWSTR -> "wstr"
; lpszPathName : LPWSTR -> "wstr"
; dwNameSpace : DWORD -> "int"
; dwVersion : DWORD -> "int"
; lpProviderId : GUID* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。