ホーム › System.Rpc › RpcEpRegisterNoReplaceA

RpcEpRegisterNoReplaceA

関数

既存の登録を置き換えずにエンドポイントマッパーへRPCエンドポイントを登録する(ANSI版)。

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

シグネチャ

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

RPC_STATUS RpcEpRegisterNoReplaceA(
    void* IfSpec,
    RPC_BINDING_VECTOR* BindingVector,
    UUID_VECTOR* UuidVector,   // optional
    LPSTR Annotation   // optional
);

パラメーター

名前	型	方向	説明
IfSpec	void*	in	ローカルのエンドポイントマップデータベースに登録するインターフェイス。
BindingVector	RPC_BINDING_VECTOR*	in	サーバーがリモートプロシージャコールを受信できるバインディングハンドルのベクターへのポインター。
UuidVector	UUID_VECTOR*	inoptional	サーバーが提供するオブジェクト UUID のベクターへのポインター。このベクターはサーバーアプリケーションが構築します。パラメーターの値が null の場合は、登録するオブジェクト UUID がないことを示します。
Annotation	LPSTR	inoptional	ローカルのエンドポイントマップデータベースに追加される各クロス積要素に適用される文字列コメントへのポインター。この文字列は、null 終端文字を含めて最大 64 文字です。注釈文字列がない場合は、null 値または null 終端文字列 ("\0") を指定します。注釈文字列は、アプリケーションが情報提供の目的でのみ使用します。RPC はこの文字列を、クライアントが通信するサーバーインスタンスの決定や、エンドポイントマップデータベース内の要素の列挙には使用しません。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcEpRegisterNoReplace 関数は、ローカルのエンドポイントマップデータベースにサーバーのアドレス情報を追加します。(RpcEpRegisterNoReplaceA)

戻り値

値	説明
RPC_S_OK	呼び出しに成功しました。
RPC_S_NO_BINDINGS	バインディングがありません。
RPC_S_INVALID_BINDING	バインディングハンドルが無効でした。
RPC_S_WRONG_KIND_OF_BINDING	この操作に対して誤った種類のバインディングでした。

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

解説(Remarks)

RpcEpRegisterNoReplace 関数は、ローカルホストのエンドポイントマップデータベースにエントリを追加します。この関数は既存のデータベースエントリを置き換えません。

同じホスト上でサーバーの複数のインスタンスが実行される場合、サーバーは RpcEpRegister ではなく RpcEpRegisterNoReplace を使用します。つまり、複数のサーバーインスタンスが同時に同じインターフェイス UUID、オブジェクト UUID、プロトコルシーケンスを提供する場合に、この関数を使用します。

RpcEpRegisterNoReplace の呼び出しではエントリが置き換えられないため、サーバーは実行を停止する前に自身の登録を解除する必要があります。そうしないと、サーバーインスタンスが RpcEpUnregister を呼び出さずに停止するたびに、古いデータが蓄積されます。古いエントリが残っていると、クライアントが存在しないサーバーのエンドポイントを受け取る可能性が高くなります。その場合、クライアントは別のエンドポイントを取得するまで、存在しないサーバーとの通信を試みて時間を費やすことになります。

サーバーは、エンドポイントマッパーデータベースにエントリを登録するために RpcEpRegister と RpcEpRegisterNoReplace を使用できます。Windows 2000 より前は、既に実行されていない以前のサーバーインスタンスによってエンドポイントマッパーデータベースに残された古いエントリを、サーバーが上書きできるようにするために 2 つの関数が用意されていました。現在は、サーバーインスタンスが機能を停止すると、そのサーバーインスタンスによって登録されたエントリはエンドポイントマッパーデータベースから自動的に削除されます。ただし、セキュリティ上の理由から、サーバーが他のサーバーのエンドポイントマッパーエントリを置き換えることは許可されていません。したがって、RpcEpRegister と RpcEpRegisterNoReplace は、ほぼ同じ機能を実行します。

サーバーアプリケーションは、次のいずれかの関数を呼び出して指定したエンドポイントを登録するために RpcEpRegister を呼び出します。

サーバーがネームサービスデータベースにもエクスポートする場合、サーバーは RpcNsBindingExport 関数の呼び出し時に使用したものと同じ IfSpec、BindingVector、UuidVector の値を指定して RpcEpRegister を呼び出します。

エンドポイントを指定せずにプロトコルシーケンスを使用した場合、RPC ランタイムライブラリは動的エンドポイントを自動的に生成します。この場合、サーバーは RpcServerInqBindings を呼び出し、続いて RpcEpRegisterNoReplace を呼び出すことで、複数のクライアントから利用可能になります。そうしない場合、自動的に開始されたサーバーは、そのサーバーを開始したクライアントにのみ認識されます。

エンドポイントマップデータベースに追加される各要素には、論理的に次の情報が含まれます。

インターフェイス UUID
インターフェイスのバージョン (メジャーおよびマイナー)
バインディングハンドル
オブジェクト UUID (省略可能)
注釈 (省略可能)

RpcEpRegisterNoReplace は、IfSpec、BindingVector、UuidVector の各パラメーターからクロス積を作成し、そのクロス積の各要素を個別の登録としてエンドポイントマップデータベースに追加します。

メモ

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

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

各言語での呼び出し定義

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

RPC_STATUS RpcEpRegisterNoReplaceA(
    void* IfSpec,
    RPC_BINDING_VECTOR* BindingVector,
    UUID_VECTOR* UuidVector,   // optional
    LPSTR Annotation   // optional
);

[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcEpRegisterNoReplaceA(
    IntPtr IfSpec,   // void*
    IntPtr BindingVector,   // RPC_BINDING_VECTOR*
    IntPtr UuidVector,   // UUID_VECTOR* optional
    [MarshalAs(UnmanagedType.LPStr)] string Annotation   // LPSTR optional
);

<DllImport("RPCRT4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcEpRegisterNoReplaceA(
    IfSpec As IntPtr,   ' void*
    BindingVector As IntPtr,   ' RPC_BINDING_VECTOR*
    UuidVector As IntPtr,   ' UUID_VECTOR* optional
    <MarshalAs(UnmanagedType.LPStr)> Annotation As String   ' LPSTR optional
) As Integer
End Function

' IfSpec : void*
' BindingVector : RPC_BINDING_VECTOR*
' UuidVector : UUID_VECTOR* optional
' Annotation : LPSTR optional
Declare PtrSafe Function RpcEpRegisterNoReplaceA Lib "rpcrt4" ( _
    ByVal IfSpec As LongPtr, _
    ByVal BindingVector As LongPtr, _
    ByVal UuidVector As LongPtr, _
    ByVal Annotation As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcEpRegisterNoReplaceA = ctypes.windll.rpcrt4.RpcEpRegisterNoReplaceA
RpcEpRegisterNoReplaceA.restype = ctypes.c_int
RpcEpRegisterNoReplaceA.argtypes = [
    ctypes.POINTER(None),  # IfSpec : void*
    ctypes.c_void_p,  # BindingVector : RPC_BINDING_VECTOR*
    ctypes.c_void_p,  # UuidVector : UUID_VECTOR* optional
    wintypes.LPCSTR,  # Annotation : LPSTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcEpRegisterNoReplaceA = Fiddle::Function.new(
  lib['RpcEpRegisterNoReplaceA'],
  [
    Fiddle::TYPE_VOIDP,  # IfSpec : void*
    Fiddle::TYPE_VOIDP,  # BindingVector : RPC_BINDING_VECTOR*
    Fiddle::TYPE_VOIDP,  # UuidVector : UUID_VECTOR* optional
    Fiddle::TYPE_VOIDP,  # Annotation : LPSTR optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcEpRegisterNoReplaceA(
        IfSpec: *mut (),  // void*
        BindingVector: *mut RPC_BINDING_VECTOR,  // RPC_BINDING_VECTOR*
        UuidVector: *mut UUID_VECTOR,  // UUID_VECTOR* optional
        Annotation: *mut u8  // LPSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi)]
public static extern int RpcEpRegisterNoReplaceA(IntPtr IfSpec, IntPtr BindingVector, IntPtr UuidVector, [MarshalAs(UnmanagedType.LPStr)] string Annotation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcEpRegisterNoReplaceA' -Namespace Win32 -PassThru
# $api::RpcEpRegisterNoReplaceA(IfSpec, BindingVector, UuidVector, Annotation)

#uselib "RPCRT4.dll"
#func global RpcEpRegisterNoReplaceA "RpcEpRegisterNoReplaceA" sptr, sptr, sptr, sptr
; RpcEpRegisterNoReplaceA IfSpec, varptr(BindingVector), varptr(UuidVector), Annotation   ; 戻り値は stat
; IfSpec : void* -> "sptr"
; BindingVector : RPC_BINDING_VECTOR* -> "sptr"
; UuidVector : UUID_VECTOR* optional -> "sptr"
; Annotation : LPSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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