ホーム › System.Rpc › RpcNsMgmtBindingUnexportA

RpcNsMgmtBindingUnexportA

関数

管理操作としてネームサービスからインターフェイスのバインディングをエクスポート解除する(ANSI版)。

DLLRPCNS4.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// RPCNS4.dll  (ANSI / -A)
#include <windows.h>

RPC_STATUS RpcNsMgmtBindingUnexportA(
    DWORD EntryNameSyntax,
    LPSTR EntryName,
    RPC_IF_ID* IfId,   // optional
    DWORD VersOption,
    UUID_VECTOR* ObjectUuidVec   // optional
);

パラメーター

名前

型

方向

説明

EntryNameSyntax

DWORD

EntryName の構文。

レジストリ値エントリ HKEY_LOCAL_MACHINE\Software\Microsoft\Rpc\NameService\DefaultSyntax で指定された構文を使用するには、RPC_C_NS_SYNTAX_DEFAULT を指定します。

EntryName

LPSTR

バインディングハンドルとオブジェクト UUID を削除する対象のエントリ名へのポインター。

IfId

RPC_IF_ID*

inoptional

インターフェイス識別情報へのポインター。この引数に null を指定した場合、バインディングハンドルはアンエクスポートされず、オブジェクト UUID のみがアンエクスポートされます。

VersOption

DWORD

RpcNsMgmtBindingUnexport 関数が、IfId 引数が指す構造体の VersMajor メンバーおよび VersMinor メンバーをどのように使用するかを指定します。

次の表は、VersOption 引数に指定できる値を示します。

VersOption の値	意味
RPC_C_VERS_ALL	バージョン番号に関係なく、IfId のインターフェイス UUID に対するすべてのバインディングをアンエクスポートします。この値を使用する場合は、IfId のメジャーバージョンとマイナーバージョンの両方に 0 を指定します。
RPC_C_VERS_IF_ID	IfId と同じメジャーバージョンを持ち、マイナーバージョンが IfId のマイナーバージョン以上である、互換性のあるインターフェイス UUID のバインディングをアンエクスポートします。
RPC_C_VERS_EXACT	IfId と同じメジャーバージョンおよびマイナーバージョンを持つ、IfId のインターフェイス UUID のバインディングをアンエクスポートします。
RPC_C_VERS_MAJOR_ONLY	IfId と同じメジャーバージョンを持つ、IfId のインターフェイス UUID のバインディングをアンエクスポートします (マイナーバージョンは無視されます)。この値を使用する場合は、IfId のマイナーバージョンに 0 を指定します。
RPC_C_VERS_UPTO	指定されたインターフェイス UUID のうち、指定されたメジャーバージョンおよびマイナーバージョン以下のバージョンを提供するバインディングをアンエクスポートします。(たとえば、IfId に V2.0 が含まれ、ネームサービスデータベースのエントリにバージョン 1.3、2.0、2.1 のバインディングハンドルが含まれている場合、 RpcNsMgmtBindingUnexport 関数はバージョン 1.3 と 2.0 のバインディングハンドルをアンエクスポートします。)

ObjectUuidVec

UUID_VECTOR*

inoptional

サーバーが提供を取りやめるオブジェクト UUID のベクターへのポインター。このベクターはアプリケーションが構築します。null を指定した場合、アンエクスポートするオブジェクト UUID は存在せず、バインディングハンドルのみがアンエクスポートされます。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcNsMgmtBindingUnexport 関数は、ネームサービスデータベース内のエントリから複数のバインディングハンドルとオブジェクトを削除します。(ANSI)

戻り値

値	意味
RPC_S_OK	呼び出しが成功しました。
RPC_S_INVALID_VERS_OPTION	バージョンオプションが無効です。
RPC_S_INVALID_NAME_SYNTAX	名前の構文が無効です。
RPC_S_UNSUPPORTED_NAME_SYNTAX	名前の構文がサポートされていません。
RPC_S_INCOMPLETE_NAME	名前が不完全です。
RPC_S_ENTRY_NOT_FOUND	ネームサービスのエントリが見つかりませんでした。
RPC_S_NAME_SERVICE_UNAVAILABLE	ネームサービスを利用できません。
RPC_S_INTERFACE_NOT_FOUND	インターフェイスが見つかりませんでした。
RPC_S_NOT_ALL_OBJS_UNEXPORTED	すべてのオブジェクトがアンエクスポートされたわけではありません。

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

解説(Remarks)

RpcNsMgmtBindingUnexport 関数を使用すると、管理アプリケーションはネームサービスデータベースのエントリから次のいずれかを削除できます。

指定されたインターフェイス UUID に対する、インターフェイスのバージョン番号 (メジャーおよびマイナー) で絞り込まれたすべてのバインディングハンドル
1 つ以上のリソースのオブジェクト UUID
バインディングハンドルとリソースのオブジェクト UUID の両方

管理アプリケーションは、 RpcNsMgmtBindingUnexport の 1 回の呼び出しでインターフェイスとオブジェクトをアンエクスポートすることも、別々にアンエクスポートすることもできます。 RpcNsMgmtBindingUnexport が指定されたインターフェイスのバインディングハンドルを 1 つも見つけられなかった場合、この関数は RPC_S_INTERFACE_NOT_FOUND ステータスコードを返し、オブジェクト UUID が指定されていたとしてもアンエクスポートしません。

指定されたインターフェイスのバインディングハンドルが 1 つ以上見つかり、エラーなくアンエクスポートされた場合、 RpcNsMgmtBindingUnexport は指定されたオブジェクト UUID をアンエクスポートします。指定されたオブジェクト UUID のいずれかが見つからなかった場合、 RpcNsMgmtBindingUnexport は RPC_S_NOT_ALL_OBJS_UNEXPORTED を返します。

管理アプリケーションは、 RpcNsMgmtBindingUnexport の呼び出しに加えて、 RpcMgmtEpUnregister 関数も呼び出して、エンドポイントマップデータベースに登録されているサーバーの登録を解除する必要があります。

注意ネームサービスデータベースは、比較的安定していることを前提として設計されています。レプリケーションされたネームサービスでは、 RpcNsBindingExport 関数と RpcNsBindingUnexport 関数を頻繁に使用すると、ネームサービスが同じエントリの削除と置き換えを繰り返すことになり、パフォーマンスの問題を引き起こす可能性があります。

メモ

rpcnsi.h ヘッダーは、UNICODE プリプロセッサー定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RpcNsMgmtBindingUnexport を定義しています。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// RPCNS4.dll  (ANSI / -A)
#include <windows.h>

RPC_STATUS RpcNsMgmtBindingUnexportA(
    DWORD EntryNameSyntax,
    LPSTR EntryName,
    RPC_IF_ID* IfId,   // optional
    DWORD VersOption,
    UUID_VECTOR* ObjectUuidVec   // optional
);

[DllImport("RPCNS4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcNsMgmtBindingUnexportA(
    uint EntryNameSyntax,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string EntryName,   // LPSTR
    IntPtr IfId,   // RPC_IF_ID* optional
    uint VersOption,   // DWORD
    IntPtr ObjectUuidVec   // UUID_VECTOR* optional
);

<DllImport("RPCNS4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcNsMgmtBindingUnexportA(
    EntryNameSyntax As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> EntryName As String,   ' LPSTR
    IfId As IntPtr,   ' RPC_IF_ID* optional
    VersOption As UInteger,   ' DWORD
    ObjectUuidVec As IntPtr   ' UUID_VECTOR* optional
) As Integer
End Function

' EntryNameSyntax : DWORD
' EntryName : LPSTR
' IfId : RPC_IF_ID* optional
' VersOption : DWORD
' ObjectUuidVec : UUID_VECTOR* optional
Declare PtrSafe Function RpcNsMgmtBindingUnexportA Lib "rpcns4" ( _
    ByVal EntryNameSyntax As Long, _
    ByVal EntryName As String, _
    ByVal IfId As LongPtr, _
    ByVal VersOption As Long, _
    ByVal ObjectUuidVec As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcNsMgmtBindingUnexportA = ctypes.windll.rpcns4.RpcNsMgmtBindingUnexportA
RpcNsMgmtBindingUnexportA.restype = ctypes.c_int
RpcNsMgmtBindingUnexportA.argtypes = [
    wintypes.DWORD,  # EntryNameSyntax : DWORD
    wintypes.LPCSTR,  # EntryName : LPSTR
    ctypes.c_void_p,  # IfId : RPC_IF_ID* optional
    wintypes.DWORD,  # VersOption : DWORD
    ctypes.c_void_p,  # ObjectUuidVec : UUID_VECTOR* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCNS4.dll')
RpcNsMgmtBindingUnexportA = Fiddle::Function.new(
  lib['RpcNsMgmtBindingUnexportA'],
  [
    -Fiddle::TYPE_INT,  # EntryNameSyntax : DWORD
    Fiddle::TYPE_VOIDP,  # EntryName : LPSTR
    Fiddle::TYPE_VOIDP,  # IfId : RPC_IF_ID* optional
    -Fiddle::TYPE_INT,  # VersOption : DWORD
    Fiddle::TYPE_VOIDP,  # ObjectUuidVec : UUID_VECTOR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcns4")]
extern "system" {
    fn RpcNsMgmtBindingUnexportA(
        EntryNameSyntax: u32,  // DWORD
        EntryName: *mut u8,  // LPSTR
        IfId: *mut RPC_IF_ID,  // RPC_IF_ID* optional
        VersOption: u32,  // DWORD
        ObjectUuidVec: *mut UUID_VECTOR  // UUID_VECTOR* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCNS4.dll", CharSet = CharSet.Ansi)]
public static extern int RpcNsMgmtBindingUnexportA(uint EntryNameSyntax, [MarshalAs(UnmanagedType.LPStr)] string EntryName, IntPtr IfId, uint VersOption, IntPtr ObjectUuidVec);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCNS4_RpcNsMgmtBindingUnexportA' -Namespace Win32 -PassThru
# $api::RpcNsMgmtBindingUnexportA(EntryNameSyntax, EntryName, IfId, VersOption, ObjectUuidVec)

#uselib "RPCNS4.dll"
#func global RpcNsMgmtBindingUnexportA "RpcNsMgmtBindingUnexportA" sptr, sptr, sptr, sptr, sptr
; RpcNsMgmtBindingUnexportA EntryNameSyntax, EntryName, varptr(IfId), VersOption, varptr(ObjectUuidVec)   ; 戻り値は stat
; EntryNameSyntax : DWORD -> "sptr"
; EntryName : LPSTR -> "sptr"
; IfId : RPC_IF_ID* optional -> "sptr"
; VersOption : DWORD -> "sptr"
; ObjectUuidVec : UUID_VECTOR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCNS4.dll"
#cfunc global RpcNsMgmtBindingUnexportA "RpcNsMgmtBindingUnexportA" int, str, var, int, var
; res = RpcNsMgmtBindingUnexportA(EntryNameSyntax, EntryName, IfId, VersOption, ObjectUuidVec)
; EntryNameSyntax : DWORD -> "int"
; EntryName : LPSTR -> "str"
; IfId : RPC_IF_ID* optional -> "var"
; VersOption : DWORD -> "int"
; ObjectUuidVec : UUID_VECTOR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCNS4.dll"
#cfunc global RpcNsMgmtBindingUnexportA "RpcNsMgmtBindingUnexportA" int, str, sptr, int, sptr
; res = RpcNsMgmtBindingUnexportA(EntryNameSyntax, EntryName, varptr(IfId), VersOption, varptr(ObjectUuidVec))
; EntryNameSyntax : DWORD -> "int"
; EntryName : LPSTR -> "str"
; IfId : RPC_IF_ID* optional -> "sptr"
; VersOption : DWORD -> "int"
; ObjectUuidVec : UUID_VECTOR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。