ホーム › System.Rpc › RpcServerUnregisterIfEx

RpcServerUnregisterIfEx

関数

ランダウン制御付きでインターフェイス登録を解除する。

DLLRPCRT4.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

RPC_STATUS RpcServerUnregisterIfEx(
    void* IfSpec,   // optional
    GUID* MgrTypeUuid,   // optional
    INT RundownContextHandles
);

パラメーター

名前	型	方向	説明
IfSpec	void*	inoptional	レジストリから削除するインターフェイス。 MgrTypeUuid パラメーターで指定された型 UUID 値で以前に登録されたすべてのインターフェイスを削除するには、null 値を指定します。
MgrTypeUuid	GUID*	inoptional	レジストリから削除するマネージャーエントリポイントベクター (EPV) の型 UUID へのポインター。MgrTypeUuid の値は、 RpcServerRegisterIf 関数、RpcServerRegisterIf2 関数、または RpcServerRegisterIfEx 関数の呼び出しで指定した値と同じである必要があります。 IfSpec パラメーターで指定したインターフェイスを、以前に登録されたすべての型 UUID についてレジストリから削除するには、null 値を指定します。 MIDL によって生成された既定のマネージャー EPV をレジストリから削除するには、nil UUID を指定します。この場合、nil ではない型 UUID で登録されたマネージャー EPV はすべて登録されたまま残ります。
RundownContextHandles	INT	in	アクティブなコンテキストハンドルに対してランダウンを呼び出すかどうかを指定します。0 以外の場合、インターフェイス上のすべての呼び出しが完了した時点でランダウンが呼び出されます。0 に設定した場合、RPC ランタイムは、サーバーが自身の側のコンテキストハンドルを既に破棄したものとみなし、ランダウンルーチンを呼び出しません。

名前

型

方向

説明

IfSpec

void*

inoptional

レジストリから削除するインターフェイス。

MgrTypeUuid パラメーターで指定された型 UUID 値で以前に登録されたすべてのインターフェイスを削除するには、null 値を指定します。

MgrTypeUuid

GUID*

inoptional

レジストリから削除するマネージャーエントリポイントベクター (EPV) の型 UUID へのポインター。MgrTypeUuid の値は、 RpcServerRegisterIf 関数、RpcServerRegisterIf2 関数、または RpcServerRegisterIfEx 関数の呼び出しで指定した値と同じである必要があります。

IfSpec パラメーターで指定したインターフェイスを、以前に登録されたすべての型 UUID についてレジストリから削除するには、null 値を指定します。

MIDL によって生成された既定のマネージャー EPV をレジストリから削除するには、nil UUID を指定します。この場合、nil ではない型 UUID で登録されたマネージャー EPV はすべて登録されたまま残ります。

RundownContextHandles

INT

アクティブなコンテキストハンドルに対してランダウンを呼び出すかどうかを指定します。0 以外の場合、インターフェイス上のすべての呼び出しが完了した時点でランダウンが呼び出されます。0 に設定した場合、RPC ランタイムは、サーバーが自身の側のコンテキストハンドルを既に破棄したものとみなし、ランダウンルーチンを呼び出しません。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcServerUnregisterIfEx 関数は、RPC ランタイムライブラリのレジストリからインターフェイスを削除します。この関数は RpcServerUnregisterIf 関数の機能を拡張したものです。

戻り値

RPC の状態を返します。 RpcServerUnregisterIfEx は、無効な値が指定されない限り失敗しません。

注有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

RpcServerUnregisterIfEx 関数は、コンテキストハンドルの登録を解除する前に、指定されたインターフェイス上のすべての呼び出しが完了するのを待機します。

RpcServerUnregisterIfEx 関数は、 RpcServerUnregisterIf 関数が提供するすべての機能を備えています。さらに、 RpcServerUnregisterIfEx 関数は、指定されたインターフェイスによって登録されたすべてのコンテキストハンドルの登録を解除します。インターフェイスは strict_context_handle 属性を使用する必要があります。使用しない場合、結果は未定義です。

RpcServerUnregisterIfEx は、プロセスのシャットダウン時以外に、アクティブなコンテキストハンドルを持つ DLL を安全にアンロードできる唯一の関数です。この関数は Windows XP 以降の Windows でのみ使用できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

RPC_STATUS RpcServerUnregisterIfEx(
    void* IfSpec,   // optional
    GUID* MgrTypeUuid,   // optional
    INT RundownContextHandles
);

[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcServerUnregisterIfEx(
    IntPtr IfSpec,   // void* optional
    IntPtr MgrTypeUuid,   // GUID* optional
    int RundownContextHandles   // INT
);

<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcServerUnregisterIfEx(
    IfSpec As IntPtr,   ' void* optional
    MgrTypeUuid As IntPtr,   ' GUID* optional
    RundownContextHandles As Integer   ' INT
) As Integer
End Function

' IfSpec : void* optional
' MgrTypeUuid : GUID* optional
' RundownContextHandles : INT
Declare PtrSafe Function RpcServerUnregisterIfEx Lib "rpcrt4" ( _
    ByVal IfSpec As LongPtr, _
    ByVal MgrTypeUuid As LongPtr, _
    ByVal RundownContextHandles As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcServerUnregisterIfEx = ctypes.windll.rpcrt4.RpcServerUnregisterIfEx
RpcServerUnregisterIfEx.restype = ctypes.c_int
RpcServerUnregisterIfEx.argtypes = [
    ctypes.POINTER(None),  # IfSpec : void* optional
    ctypes.c_void_p,  # MgrTypeUuid : GUID* optional
    ctypes.c_int,  # RundownContextHandles : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcServerUnregisterIfEx = Fiddle::Function.new(
  lib['RpcServerUnregisterIfEx'],
  [
    Fiddle::TYPE_VOIDP,  # IfSpec : void* optional
    Fiddle::TYPE_VOIDP,  # MgrTypeUuid : GUID* optional
    Fiddle::TYPE_INT,  # RundownContextHandles : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcServerUnregisterIfEx(
        IfSpec: *mut (),  // void* optional
        MgrTypeUuid: *mut GUID,  // GUID* optional
        RundownContextHandles: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll")]
public static extern int RpcServerUnregisterIfEx(IntPtr IfSpec, IntPtr MgrTypeUuid, int RundownContextHandles);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcServerUnregisterIfEx' -Namespace Win32 -PassThru
# $api::RpcServerUnregisterIfEx(IfSpec, MgrTypeUuid, RundownContextHandles)

#uselib "RPCRT4.dll"
#func global RpcServerUnregisterIfEx "RpcServerUnregisterIfEx" sptr, sptr, sptr
; RpcServerUnregisterIfEx IfSpec, varptr(MgrTypeUuid), RundownContextHandles   ; 戻り値は stat
; IfSpec : void* optional -> "sptr"
; MgrTypeUuid : GUID* optional -> "sptr"
; RundownContextHandles : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCRT4.dll"
#cfunc global RpcServerUnregisterIfEx "RpcServerUnregisterIfEx" sptr, var, int
; res = RpcServerUnregisterIfEx(IfSpec, MgrTypeUuid, RundownContextHandles)
; IfSpec : void* optional -> "sptr"
; MgrTypeUuid : GUID* optional -> "var"
; RundownContextHandles : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCRT4.dll"
#cfunc global RpcServerUnregisterIfEx "RpcServerUnregisterIfEx" sptr, sptr, int
; res = RpcServerUnregisterIfEx(IfSpec, varptr(MgrTypeUuid), RundownContextHandles)
; IfSpec : void* optional -> "sptr"
; MgrTypeUuid : GUID* optional -> "sptr"
; RundownContextHandles : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。