WSAAdvertiseProvider
関数シグネチャ
// WS2_32.dll
#include <windows.h>
INT WSAAdvertiseProvider(
const GUID* puuidProviderId,
const NSPV2_ROUTINE* pNSPv2Routine
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| puuidProviderId | GUID* | in | アドバタイズするネームスペースプロバイダーのプロバイダー ID へのポインター。 |
| pNSPv2Routine | NSPV2_ROUTINE* | in | プロバイダーがサポートするネームスペースサービスプロバイダー version-2 のエントリポイントを格納した NSPV2_ROUTINE 構造体へのポインター。 |
戻り値の型: INT
公式ドキュメント
特定のネームスペース version-2 プロバイダーを、すべての対象クライアントが利用できるようにします。
戻り値
エラーが発生しない場合、 WSAProviderCompleteAsyncCall はゼロを返します。
関数が失敗した場合、戻り値は SOCKET_ERROR です。拡張エラー情報を取得するには WSAGetLastError を呼び出します。これは次のいずれかの拡張エラー値を返します。
| エラーコード | 意味 |
|---|---|
| 操作を実行するのに十分なメモリがありませんでした。 | |
| 内部エラーが発生しました。 | |
|
パラメーターが無効でした。このエラーは、puuidProviderId または pNSPv2Routine パラメーターが **NULL** の場合に返されます。
このエラーは、pNSPv2Routine パラメーターが指す NSPV2_ROUTINE 構造体の NSPv2LookupServiceBegin、NSPv2LookupServiceNextEx、または NSPv2LookupServiceEnd メンバーが NULL の場合にも返されます。ネームスペース version-2 プロバイダーは、少なくともこの最小限の関数セットによる名前解決をサポートする必要があります。 |
|
| 指定された puuidProviderId パラメーターに対応するネームスペースプロバイダーが見つかりませんでした。 | |
| Ws2_32.dll が初期化されていません。アプリケーションは、Windows Sockets 関数を呼び出す前に、まず WSAStartup を呼び出す必要があります。 |
解説(Remarks)
WSAAdvertiseProvider 関数は、Windows Vista 以降で利用可能なネームスペースサービスプロバイダー version-2 (NSPv2) アーキテクチャの一部として使用されます。
Windows Vista および Windows Server 2008 では、WSAAdvertiseProvider 関数は NS_EMAIL ネームスペースプロバイダーに対する操作にのみ使用できます。
WSAAdvertiseProvider 関数は、クライアントが見つけられるように NSPv2 プロバイダーのインスタンスをアドバタイズします。アドバタイズするインスタンスがアプリケーション型プロバイダー (NAPI_PROVIDER_INSTALLATION_BLOB 構造体の dwProvideType メンバーが ProviderType_Application であるネームスペースプロバイダー) のインスタンスである場合、アドバタイズされたプロバイダーインスタンスは、WSAAdvertiseProvider の呼び出し元と同じユーザーかつ同じセッションで実行されているすべてのクライアントプロセスから参照できます。
一般に、NSPv2 プロバイダーは呼び出し側アプリケーションとは別のプロセスで実装されます。NSPv2 プロバイダーはクライアントの動作の結果として起動されることはありません。各プロバイダーホスティングアプリケーションは、WSAAdvertiseProvider および WSAUnadvertiseProvider 関数を呼び出すことで、特定のプロバイダーをいつ利用可能または利用不可にするかを決定します。クライアントの動作は、プロバイダーが利用可能な場合 (ネームスペースプロバイダーがアドバタイズされている場合) にのみ、プロバイダーへの接続を試みる結果になります。
WSAAdvertiseProvider 関数は、特定のプロバイダーをすべての対象クライアント (現在のところ、ホスティングアプリケーションと同じ資格情報かつ同じユーザーセッションで実行されているすべてのアプリケーション) が利用できるようにしたいアプリケーションによって呼び出されます。
1 つのプロセスは、複数のプロバイダーを同時に実装してアドバタイズできます。Windows Sockets は、呼び出しを正しいプロバイダーにディスパッチすることでネームスペースプロバイダーを管理します。また、RPC インターフェイスの詳細を隠蔽し、プロセス間呼び出しをプロセス内呼び出しに変換します。これにより、NSPv2 プロバイダーは、NSPv1 プロバイダーが使用する NSP_ROUTINE 構造体に似たエントリポイント関数のテーブルを実装するだけで済みます。NSPv2 プロバイダーは、RPC 固有の要件 (たとえばデータのマーシャリングやシリアル化) を考慮する必要はありません。
WSAAdvertiseProvider の呼び出し元は、プロバイダーがサポートする NSPv2 エントリポイントを格納した NSPV2_ROUTINE 構造体へのポインターを pNSPv2Routine パラメーターで渡します。
WSAUnadvertiseProvider 関数は、特定のネームスペースプロバイダーをクライアントが利用できないようにします。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WS2_32.dll
#include <windows.h>
INT WSAAdvertiseProvider(
const GUID* puuidProviderId,
const NSPV2_ROUTINE* pNSPv2Routine
);[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAAdvertiseProvider(
ref Guid puuidProviderId, // GUID*
IntPtr pNSPv2Routine // NSPV2_ROUTINE*
);<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAAdvertiseProvider(
ByRef puuidProviderId As Guid, ' GUID*
pNSPv2Routine As IntPtr ' NSPV2_ROUTINE*
) As Integer
End Function' puuidProviderId : GUID*
' pNSPv2Routine : NSPV2_ROUTINE*
Declare PtrSafe Function WSAAdvertiseProvider Lib "ws2_32" ( _
ByVal puuidProviderId As LongPtr, _
ByVal pNSPv2Routine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WSAAdvertiseProvider = ctypes.windll.ws2_32.WSAAdvertiseProvider
WSAAdvertiseProvider.restype = ctypes.c_int
WSAAdvertiseProvider.argtypes = [
ctypes.c_void_p, # puuidProviderId : GUID*
ctypes.c_void_p, # pNSPv2Routine : NSPV2_ROUTINE*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WS2_32.dll')
WSAAdvertiseProvider = Fiddle::Function.new(
lib['WSAAdvertiseProvider'],
[
Fiddle::TYPE_VOIDP, # puuidProviderId : GUID*
Fiddle::TYPE_VOIDP, # pNSPv2Routine : NSPV2_ROUTINE*
],
Fiddle::TYPE_INT)#[link(name = "ws2_32")]
extern "system" {
fn WSAAdvertiseProvider(
puuidProviderId: *const GUID, // GUID*
pNSPv2Routine: *const NSPV2_ROUTINE // NSPV2_ROUTINE*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSAAdvertiseProvider(ref Guid puuidProviderId, IntPtr pNSPv2Routine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAAdvertiseProvider' -Namespace Win32 -PassThru
# $api::WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine)#uselib "WS2_32.dll"
#func global WSAAdvertiseProvider "WSAAdvertiseProvider" sptr, sptr
; WSAAdvertiseProvider varptr(puuidProviderId), varptr(pNSPv2Routine) ; 戻り値は stat
; puuidProviderId : GUID* -> "sptr"
; pNSPv2Routine : NSPV2_ROUTINE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WS2_32.dll" #cfunc global WSAAdvertiseProvider "WSAAdvertiseProvider" var, var ; res = WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine) ; puuidProviderId : GUID* -> "var" ; pNSPv2Routine : NSPV2_ROUTINE* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll" #cfunc global WSAAdvertiseProvider "WSAAdvertiseProvider" sptr, sptr ; res = WSAAdvertiseProvider(varptr(puuidProviderId), varptr(pNSPv2Routine)) ; puuidProviderId : GUID* -> "sptr" ; pNSPv2Routine : NSPV2_ROUTINE* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; INT WSAAdvertiseProvider(GUID* puuidProviderId, NSPV2_ROUTINE* pNSPv2Routine) #uselib "WS2_32.dll" #cfunc global WSAAdvertiseProvider "WSAAdvertiseProvider" var, var ; res = WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine) ; puuidProviderId : GUID* -> "var" ; pNSPv2Routine : NSPV2_ROUTINE* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT WSAAdvertiseProvider(GUID* puuidProviderId, NSPV2_ROUTINE* pNSPv2Routine) #uselib "WS2_32.dll" #cfunc global WSAAdvertiseProvider "WSAAdvertiseProvider" intptr, intptr ; res = WSAAdvertiseProvider(varptr(puuidProviderId), varptr(pNSPv2Routine)) ; puuidProviderId : GUID* -> "intptr" ; pNSPv2Routine : NSPV2_ROUTINE* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
procWSAAdvertiseProvider = ws2_32.NewProc("WSAAdvertiseProvider")
)
// puuidProviderId (GUID*), pNSPv2Routine (NSPV2_ROUTINE*)
r1, _, err := procWSAAdvertiseProvider.Call(
uintptr(puuidProviderId),
uintptr(pNSPv2Routine),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction WSAAdvertiseProvider(
puuidProviderId: PGUID; // GUID*
pNSPv2Routine: Pointer // NSPV2_ROUTINE*
): Integer; stdcall;
external 'WS2_32.dll' name 'WSAAdvertiseProvider';result := DllCall("WS2_32\WSAAdvertiseProvider"
, "Ptr", puuidProviderId ; GUID*
, "Ptr", pNSPv2Routine ; NSPV2_ROUTINE*
, "Int") ; return: INT●WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine) = DLL("WS2_32.dll", "int WSAAdvertiseProvider(void*, void*)")
# 呼び出し: WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine)
# puuidProviderId : GUID* -> "void*"
# pNSPv2Routine : NSPV2_ROUTINE* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ws2_32" fn WSAAdvertiseProvider(
puuidProviderId: [*c]GUID, // GUID*
pNSPv2Routine: [*c]NSPV2_ROUTINE // NSPV2_ROUTINE*
) callconv(std.os.windows.WINAPI) i32;proc WSAAdvertiseProvider(
puuidProviderId: ptr GUID, # GUID*
pNSPv2Routine: ptr NSPV2_ROUTINE # NSPV2_ROUTINE*
): int32 {.importc: "WSAAdvertiseProvider", stdcall, dynlib: "WS2_32.dll".}pragma(lib, "ws2_32");
extern(Windows)
int WSAAdvertiseProvider(
GUID* puuidProviderId, // GUID*
NSPV2_ROUTINE* pNSPv2Routine // NSPV2_ROUTINE*
);ccall((:WSAAdvertiseProvider, "WS2_32.dll"), stdcall, Int32,
(Ptr{GUID}, Ptr{NSPV2_ROUTINE}),
puuidProviderId, pNSPv2Routine)
# puuidProviderId : GUID* -> Ptr{GUID}
# pNSPv2Routine : NSPV2_ROUTINE* -> Ptr{NSPV2_ROUTINE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WSAAdvertiseProvider(
void* puuidProviderId,
void* pNSPv2Routine);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine)
-- puuidProviderId : GUID*
-- pNSPv2Routine : NSPV2_ROUTINE*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSAAdvertiseProvider = lib.func('__stdcall', 'WSAAdvertiseProvider', 'int32_t', ['void *', 'void *']);
// WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine)
// puuidProviderId : GUID* -> 'void *'
// pNSPv2Routine : NSPV2_ROUTINE* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WS2_32.dll", {
WSAAdvertiseProvider: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine)
// puuidProviderId : GUID* -> "pointer"
// pNSPv2Routine : NSPV2_ROUTINE* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WSAAdvertiseProvider(
void* puuidProviderId,
void* pNSPv2Routine);
C, "WS2_32.dll");
// $ffi->WSAAdvertiseProvider(puuidProviderId, pNSPv2Routine);
// puuidProviderId : GUID*
// pNSPv2Routine : NSPV2_ROUTINE*
// 構造体/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);
int WSAAdvertiseProvider(
Pointer puuidProviderId, // GUID*
Pointer pNSPv2Routine // NSPV2_ROUTINE*
);
}@[Link("ws2_32")]
lib LibWS2_32
fun WSAAdvertiseProvider = WSAAdvertiseProvider(
puuidProviderId : GUID*, # GUID*
pNSPv2Routine : NSPV2_ROUTINE* # NSPV2_ROUTINE*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WSAAdvertiseProviderNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef WSAAdvertiseProviderDart = int Function(Pointer<Void>, Pointer<Void>);
final WSAAdvertiseProvider = DynamicLibrary.open('WS2_32.dll')
.lookupFunction<WSAAdvertiseProviderNative, WSAAdvertiseProviderDart>('WSAAdvertiseProvider');
// puuidProviderId : GUID* -> Pointer<Void>
// pNSPv2Routine : NSPV2_ROUTINE* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WSAAdvertiseProvider(
puuidProviderId: PGUID; // GUID*
pNSPv2Routine: Pointer // NSPV2_ROUTINE*
): Integer; stdcall;
external 'WS2_32.dll' name 'WSAAdvertiseProvider';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WSAAdvertiseProvider"
c_WSAAdvertiseProvider :: Ptr () -> Ptr () -> IO Int32
-- puuidProviderId : GUID* -> Ptr ()
-- pNSPv2Routine : NSPV2_ROUTINE* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wsaadvertiseprovider =
foreign "WSAAdvertiseProvider"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* puuidProviderId : GUID* -> (ptr void) *)
(* pNSPv2Routine : NSPV2_ROUTINE* -> (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 ("WSAAdvertiseProvider" wsaadvertise-provider :convention :stdcall) :int32
(puuid-provider-id :pointer) ; GUID*
(p-nspv2-routine :pointer)) ; NSPV2_ROUTINE*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WSAAdvertiseProvider = Win32::API::More->new('WS2_32',
'int WSAAdvertiseProvider(LPVOID puuidProviderId, LPVOID pNSPv2Routine)');
# my $ret = $WSAAdvertiseProvider->Call($puuidProviderId, $pNSPv2Routine);
# puuidProviderId : GUID* -> LPVOID
# pNSPv2Routine : NSPV2_ROUTINE* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- s NAPI_PROVIDER_INSTALLATION_BLOB
- e NAPI_PROVIDER_TYPE
- f WSAEnumNameSpaceProvidersW — 登録済みの名前空間プロバイダーを列挙する。
- f WSAEnumNameSpaceProvidersExW — 名前空間プロバイダーを拡張情報付きで列挙する。
- f WSAProviderCompleteAsyncCall — プロバイダーの非同期呼び出しの完了を通知する。
- f WSASetServiceW — サービスインスタンスの登録や登録解除を行う。
- f WSAUnadvertiseProvider — 公開済みのNSPv2プロバイダーの公開を取り消す。
- f WSCEnumNameSpaceProvidersEx32 — 32ビットカタログの名前空間プロバイダを拡張形式で列挙する。