RpcEpRegisterA

関数

RPCインターフェイスのバインディングをエンドポイントマッパーへ登録する(ANSI版)。

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

シグネチャ

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

RPC_STATUS RpcEpRegisterA(
    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

公式ドキュメント

RpcEpRegister 関数は、ローカルのエンドポイントマップデータベースにサーバーのアドレス情報を追加、または置き換えます。(RpcEpRegisterA)

戻り値

値	意味
RPC_S_OK	呼び出しが成功しました。
RPC_S_NO_BINDINGS	バインドがありません。
RPC_S_INVALID_BINDING	バインドハンドルが無効です。
RPC_S_WRONG_KIND_OF_BINDING	この操作に対して不適切な種類のバインドです。

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

解説(Remarks)

RpcEpRegister 関数は、ローカルホストのエンドポイントマップデータベースにエントリを追加、または置き換えます。指定されたインターフェイス仕様、バインドハンドル、オブジェクト UUID に一致する既存のデータベースエントリがある場合、この関数はそのエントリのエンドポイントを、指定されたバインドハンドル内のエンドポイントで置き換えます。

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

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

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

エンドポイントを指定せずにプロトコルシーケンスを使用した場合、RPC ランタイムライブラリは動的エンドポイントを自動的に生成します。この場合、サーバーは RpcServerInqBindings を呼び出した後に RpcEpRegister を呼び出すことで、複数のクライアントから利用できるようになります。そうしない場合、自動的に開始されたサーバーは、そのサーバーを開始させたクライアントからのみ認識されます。エンドポイントマップデータベースに追加される各要素は、論理的に次の情報を含みます。

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

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

メモ

rpcdce.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RpcEpRegister を定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、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 RpcEpRegisterA(
    void* IfSpec,
    RPC_BINDING_VECTOR* BindingVector,
    UUID_VECTOR* UuidVector,   // optional
    LPSTR Annotation   // optional
);

[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcEpRegisterA(
    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 RpcEpRegisterA(
    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 RpcEpRegisterA 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

RpcEpRegisterA = ctypes.windll.rpcrt4.RpcEpRegisterA
RpcEpRegisterA.restype = ctypes.c_int
RpcEpRegisterA.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')
RpcEpRegisterA = Fiddle::Function.new(
  lib['RpcEpRegisterA'],
  [
    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 RpcEpRegisterA(
        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 RpcEpRegisterA(IntPtr IfSpec, IntPtr BindingVector, IntPtr UuidVector, [MarshalAs(UnmanagedType.LPStr)] string Annotation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcEpRegisterA' -Namespace Win32 -PassThru
# $api::RpcEpRegisterA(IfSpec, BindingVector, UuidVector, Annotation)

#uselib "RPCRT4.dll"
#func global RpcEpRegisterA "RpcEpRegisterA" sptr, sptr, sptr, sptr
; RpcEpRegisterA 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 RpcEpRegisterA "RpcEpRegisterA" sptr, var, var, str
; res = RpcEpRegisterA(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 RpcEpRegisterA "RpcEpRegisterA" sptr, sptr, sptr, str
; res = RpcEpRegisterA(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(変数))。