ホーム › Networking.WinSock › WSCInstallNameSpace

WSCInstallNameSpace

関数

名前空間プロバイダーを登録する。

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

シグネチャ

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

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

パラメーター

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

戻り値の型: INT

公式ドキュメント

名前空間プロバイダーをインストールします。(WSCInstallNameSpace)

戻り値

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

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

解説(Remarks)

名前空間構成関数は、既に実行中のアプリケーションには影響しません。新しくインストールされた名前空間プロバイダーは、アプリケーションからは認識されず、名前空間プロバイダーのアクティブ化状態の変更も反映されません。 WSCInstallNameSpace の呼び出し後に起動されたアプリケーションには、これらの変更が反映されます。

WSCInstallNameSpace 関数は、Administrators グループのメンバーとしてログオンしたユーザーのみが呼び出すことができます。Administrators グループのメンバーでないユーザーが WSCInstallNameSpace を呼び出した場合、関数の呼び出しは失敗します。 Windows Vista または Windows Server 2008 で動作するコンピューターでは、ユーザーアカウント制御 (UAC) が原因でこの関数が失敗することもあります。この関数を含むアプリケーションが、ビルトインの Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。Windows Vista または Windows Server 2008 上のアプリケーションにこのマニフェストファイルがない場合、ビルトインの Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーは、この関数を成功させるために、ビルトインの 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 WSCInstallNameSpace(
    LPWSTR lpszIdentifier,
    LPWSTR lpszPathName,
    DWORD dwNameSpace,
    DWORD dwVersion,
    GUID* lpProviderId
);

[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCInstallNameSpace(
    [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 WSCInstallNameSpace(
    <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 WSCInstallNameSpace 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

WSCInstallNameSpace = ctypes.windll.ws2_32.WSCInstallNameSpace
WSCInstallNameSpace.restype = ctypes.c_int
WSCInstallNameSpace.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')
WSCInstallNameSpace = Fiddle::Function.new(
  lib['WSCInstallNameSpace'],
  [
    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 WSCInstallNameSpace(
        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 WSCInstallNameSpace([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_WSCInstallNameSpace' -Namespace Win32 -PassThru
# $api::WSCInstallNameSpace(lpszIdentifier, lpszPathName, dwNameSpace, dwVersion, lpProviderId)

#uselib "WS2_32.dll"
#func global WSCInstallNameSpace "WSCInstallNameSpace" sptr, sptr, sptr, sptr, sptr
; WSCInstallNameSpace 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 WSCInstallNameSpace "WSCInstallNameSpace" wstr, wstr, int, int, var
; res = WSCInstallNameSpace(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 WSCInstallNameSpace "WSCInstallNameSpace" wstr, wstr, int, int, sptr
; res = WSCInstallNameSpace(lpszIdentifier, lpszPathName, dwNameSpace, dwVersion, varptr(lpProviderId))
; lpszIdentifier : LPWSTR -> "wstr"
; lpszPathName : LPWSTR -> "wstr"
; dwNameSpace : DWORD -> "int"
; dwVersion : DWORD -> "int"
; lpProviderId : GUID* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。