ホーム › Networking.WinSock › WSCInstallNameSpaceEx

WSCInstallNameSpaceEx

関数

プロバイダー固有情報付きで名前空間を登録する。

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

シグネチャ

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

INT WSCInstallNameSpaceEx(
    LPWSTR lpszIdentifier,
    LPWSTR lpszPathName,
    DWORD dwNameSpace,
    DWORD dwVersion,
    GUID* lpProviderId,
    BLOB* lpProviderSpecific
);

パラメーター

名前	型	方向	説明
lpszIdentifier	LPWSTR	in	lpProviderId パラメーターで渡される GUID (globally unique identifier) に関連付けられたプロバイダーを識別する文字列へのポインター。
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 によって生成する必要があります。
lpProviderSpecific	BLOB*	in	ネームスペースエントリに関連付けられた、プロバイダー固有のデータ blob。

戻り値の型: INT

公式ドキュメント

ネームスペースプロバイダーをインストールします。(WSCInstallNameSpaceEx)

戻り値

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

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

解説(Remarks)

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

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

現在、Windows に含まれるネームスペースプロバイダーのうち lpProviderInfo パラメーターを使用する唯一のものは NS_EMAIL プロバイダーです。NS_EMAIL ネームスペースプロバイダーの場合、lpProviderInfo パラメーターが指すバッファーの形式は NAPI_PROVIDER_INSTALLATION_BLOB 構造体です。

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

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

<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCInstallNameSpaceEx(
    <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*
    lpProviderSpecific As IntPtr   ' BLOB*
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSCInstallNameSpaceEx = Fiddle::Function.new(
  lib['WSCInstallNameSpaceEx'],
  [
    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_VOIDP,  # lpProviderSpecific : BLOB*
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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