Win32 API 日本語リファレンス
ホームNetworking.WinSock › WSAUnadvertiseProvider

WSAUnadvertiseProvider

関数
公開済みのNSPv2プロバイダーの公開を取り消す。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT WSAUnadvertiseProvider(
    const GUID* puuidProviderId
);

パラメーター

名前方向説明
puuidProviderIdGUID*in名前空間プロバイダーのプロバイダー ID へのポインター。

戻り値の型: INT

公式ドキュメント

特定の名前空間バージョン 2 プロバイダーを、クライアントから利用できない状態にします。

戻り値

エラーが発生しなかった場合、 WSAUnadvertiseProvider は 0 を返します。それ以外の場合は SOCKET_ERROR を返し、WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。

エラーコード 意味
WSAEINVAL
パラメーターが無効でした。このエラーは、puuidProviderId パラメーターが **NULL** であった場合に返されます。

解説(Remarks)

WSAUnadvertiseProvider 関数は、Windows Vista 以降で利用できる名前空間サービスプロバイダーバージョン 2 (NSPv2) アーキテクチャの一部として使用されます。

Windows Vista および Windows Server 2008 では、WSAUnadvertiseProvider 関数は NS_EMAIL 名前空間プロバイダーに対する操作にのみ使用できます。

一般に、NSPv2 プロバイダーは呼び出し元のアプリケーションとは別のプロセスで実装されます。NSPv2 プロバイダーは、クライアントの動作によって有効化されることはありません。プロバイダーをホストする各アプリケーションが、WSAAdvertiseProvider 関数と WSAUnadvertiseProvider 関数を呼び出すことで、特定のプロバイダーを利用可能にするか利用不可にするかを決定します。クライアントの動作は、プロバイダーが利用可能な場合 (名前空間プロバイダーがアドバタイズされている場合) にそのプロバイダーへ接続を試みる結果をもたらすだけです。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WSAUnadvertiseProvider(
    const GUID* puuidProviderId
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAUnadvertiseProvider(
    ref Guid puuidProviderId   // GUID*
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAUnadvertiseProvider(
    ByRef puuidProviderId As Guid   ' GUID*
) As Integer
End Function
' puuidProviderId : GUID*
Declare PtrSafe Function WSAUnadvertiseProvider Lib "ws2_32" ( _
    ByVal puuidProviderId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSAUnadvertiseProvider = ctypes.windll.ws2_32.WSAUnadvertiseProvider
WSAUnadvertiseProvider.restype = ctypes.c_int
WSAUnadvertiseProvider.argtypes = [
    ctypes.c_void_p,  # puuidProviderId : GUID*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAUnadvertiseProvider = Fiddle::Function.new(
  lib['WSAUnadvertiseProvider'],
  [
    Fiddle::TYPE_VOIDP,  # puuidProviderId : GUID*
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn WSAUnadvertiseProvider(
        puuidProviderId: *const GUID  // GUID*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSAUnadvertiseProvider(ref Guid puuidProviderId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAUnadvertiseProvider' -Namespace Win32 -PassThru
# $api::WSAUnadvertiseProvider(puuidProviderId)
#uselib "WS2_32.dll"
#func global WSAUnadvertiseProvider "WSAUnadvertiseProvider" sptr
; WSAUnadvertiseProvider varptr(puuidProviderId)   ; 戻り値は stat
; puuidProviderId : GUID* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSAUnadvertiseProvider "WSAUnadvertiseProvider" var
; res = WSAUnadvertiseProvider(puuidProviderId)
; puuidProviderId : GUID* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSAUnadvertiseProvider(GUID* puuidProviderId)
#uselib "WS2_32.dll"
#cfunc global WSAUnadvertiseProvider "WSAUnadvertiseProvider" var
; res = WSAUnadvertiseProvider(puuidProviderId)
; puuidProviderId : GUID* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAUnadvertiseProvider = ws2_32.NewProc("WSAUnadvertiseProvider")
)

// puuidProviderId (GUID*)
r1, _, err := procWSAUnadvertiseProvider.Call(
	uintptr(puuidProviderId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSAUnadvertiseProvider(
  puuidProviderId: PGUID   // GUID*
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSAUnadvertiseProvider';
result := DllCall("WS2_32\WSAUnadvertiseProvider"
    , "Ptr", puuidProviderId   ; GUID*
    , "Int")   ; return: INT
●WSAUnadvertiseProvider(puuidProviderId) = DLL("WS2_32.dll", "int WSAUnadvertiseProvider(void*)")
# 呼び出し: WSAUnadvertiseProvider(puuidProviderId)
# puuidProviderId : GUID* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn WSAUnadvertiseProvider(
    puuidProviderId: [*c]GUID // GUID*
) callconv(std.os.windows.WINAPI) i32;
proc WSAUnadvertiseProvider(
    puuidProviderId: ptr GUID  # GUID*
): int32 {.importc: "WSAUnadvertiseProvider", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int WSAUnadvertiseProvider(
    GUID* puuidProviderId   // GUID*
);
ccall((:WSAUnadvertiseProvider, "WS2_32.dll"), stdcall, Int32,
      (Ptr{GUID},),
      puuidProviderId)
# puuidProviderId : GUID* -> Ptr{GUID}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSAUnadvertiseProvider(
    void* puuidProviderId);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSAUnadvertiseProvider(puuidProviderId)
-- puuidProviderId : GUID*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSAUnadvertiseProvider = lib.func('__stdcall', 'WSAUnadvertiseProvider', 'int32_t', ['void *']);
// WSAUnadvertiseProvider(puuidProviderId)
// puuidProviderId : GUID* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSAUnadvertiseProvider: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.WSAUnadvertiseProvider(puuidProviderId)
// puuidProviderId : GUID* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSAUnadvertiseProvider(
    void* puuidProviderId);
C, "WS2_32.dll");
// $ffi->WSAUnadvertiseProvider(puuidProviderId);
// puuidProviderId : GUID*
// 構造体/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 WSAUnadvertiseProvider(
        Pointer puuidProviderId   // GUID*
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSAUnadvertiseProvider = WSAUnadvertiseProvider(
    puuidProviderId : GUID*   # GUID*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSAUnadvertiseProviderNative = Int32 Function(Pointer<Void>);
typedef WSAUnadvertiseProviderDart = int Function(Pointer<Void>);
final WSAUnadvertiseProvider = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSAUnadvertiseProviderNative, WSAUnadvertiseProviderDart>('WSAUnadvertiseProvider');
// puuidProviderId : GUID* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSAUnadvertiseProvider(
  puuidProviderId: PGUID   // GUID*
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSAUnadvertiseProvider';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSAUnadvertiseProvider"
  c_WSAUnadvertiseProvider :: Ptr () -> IO Int32
-- puuidProviderId : GUID* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsaunadvertiseprovider =
  foreign "WSAUnadvertiseProvider"
    ((ptr void) @-> returning int32_t)
(* puuidProviderId : GUID* -> (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 ("WSAUnadvertiseProvider" wsaunadvertise-provider :convention :stdcall) :int32
  (puuid-provider-id :pointer))   ; GUID*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSAUnadvertiseProvider = Win32::API::More->new('WS2_32',
    'int WSAUnadvertiseProvider(LPVOID puuidProviderId)');
# my $ret = $WSAUnadvertiseProvider->Call($puuidProviderId);
# puuidProviderId : GUID* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目