RpcObjectSetType

関数

オブジェクトUUIDに型UUIDを関連付ける。

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

シグネチャ

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

RPC_STATUS RpcObjectSetType(
    GUID* ObjUuid,
    GUID* TypeUuid   // optional
);

パラメーター

名前	型	方向	説明
ObjUuid	GUID*	in	TypeUuid パラメーターの型 UUID に関連付けるオブジェクト UUID へのポインター。
TypeUuid	GUID*	inoptional	ObjUuid パラメーターの型 UUID へのポインター。パラメーターの値に NULL または nil UUID を指定すると、オブジェクトの型は既定の関連付けであるオブジェクト UUID / nil 型 UUID にリセットされます。

名前

型

方向

説明

ObjUuid

GUID*

TypeUuid パラメーターの型 UUID に関連付けるオブジェクト UUID へのポインター。

TypeUuid

GUID*

inoptional

ObjUuid パラメーターの型 UUID へのポインター。

パラメーターの値に NULL または nil UUID を指定すると、オブジェクトの型は既定の関連付けであるオブジェクト UUID / nil 型 UUID にリセットされます。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcObjectSetType 関数は、オブジェクトの型を割り当てます。

戻り値

値	意味
RPC_S_OK	呼び出しに成功しました。
RPC_S_INVALID_OBJECT	オブジェクトが無効です。
RPC_S_ALREADY_REGISTERED	オブジェクトは既に登録されています。
RPC_S_OUT_OF_MEMORY	システムのメモリが不足しています。

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

解説(Remarks)

サーバーアプリケーションは、オブジェクト UUID に型 UUID を割り当てるために RpcObjectSetType を呼び出します。既定では、RPC ランタイムライブラリはすべてのオブジェクト UUID に nil 型 UUID を自動的に割り当てます。インターフェイスの実装を 1 つだけ持つ (マネージャーエントリポイントベクター [EPV] が 1 つだけの) サーバーアプリケーションは、そのインターフェイスを nil 型 UUID で登録している場合、 RpcObjectSetType を呼び出す必要はありません ( RpcServerRegisterIf を参照)。

インターフェイスの実装を複数持つ (複数のマネージャー EPV、つまり複数の型 UUID を持つ) サーバーアプリケーションは、サポートするオブジェクト UUID と nil ではない型 UUID の関連付けごとに 1 回ずつ RpcObjectSetType を呼び出します。各オブジェクトを型 UUID に関連付けることで、nil ではないオブジェクト UUID に対するリモートプロシージャコールをサーバーが受信したときに、どのマネージャー EPV (インターフェイスの実装) を使用するかを RPC ランタイムライブラリに伝えます。

RPC ランタイムライブラリでは、アプリケーションは個数の制限なくオブジェクトに型を設定できます。( RpcObjectSetType の呼び出しによって確立された) オブジェクト UUID とその型 UUID の関連付けを解除するには、サーバーは TypeUuid パラメーターに null 値または nil UUID を指定して RpcObjectSetType を再度呼び出します。これにより、オブジェクト UUID と型 UUID の関連付けは、既定の関連付けであるオブジェクト UUID / nil 型 UUID にリセットされます。サーバーは nil オブジェクト UUID に型を割り当てることはできません。RPC ランタイムライブラリは、nil オブジェクト UUID に nil 型 UUID を自動的に割り当てます。

詳細については、インターフェイスの登録を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RpcObjectSetType(
    GUID* ObjUuid,
    GUID* TypeUuid   // optional
);

[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcObjectSetType(
    ref Guid ObjUuid,   // GUID*
    IntPtr TypeUuid   // GUID* optional
);

<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcObjectSetType(
    ByRef ObjUuid As Guid,   ' GUID*
    TypeUuid As IntPtr   ' GUID* optional
) As Integer
End Function

' ObjUuid : GUID*
' TypeUuid : GUID* optional
Declare PtrSafe Function RpcObjectSetType Lib "rpcrt4" ( _
    ByVal ObjUuid As LongPtr, _
    ByVal TypeUuid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcObjectSetType = ctypes.windll.rpcrt4.RpcObjectSetType
RpcObjectSetType.restype = ctypes.c_int
RpcObjectSetType.argtypes = [
    ctypes.c_void_p,  # ObjUuid : GUID*
    ctypes.c_void_p,  # TypeUuid : GUID* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcObjectSetType = Fiddle::Function.new(
  lib['RpcObjectSetType'],
  [
    Fiddle::TYPE_VOIDP,  # ObjUuid : GUID*
    Fiddle::TYPE_VOIDP,  # TypeUuid : GUID* optional
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("RPCRT4.dll")]
public static extern int RpcObjectSetType(ref Guid ObjUuid, IntPtr TypeUuid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcObjectSetType' -Namespace Win32 -PassThru
# $api::RpcObjectSetType(ObjUuid, TypeUuid)

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

出力引数:

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