CoRegisterPSClsid

関数

インターフェースのプロキシスタブCLSIDをプロセスに登録する。

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

シグネチャ

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

HRESULT CoRegisterPSClsid(
    const GUID* riid,
    const GUID* rclsid
);

パラメーター

名前	型	方向	説明
riid	GUID*	in	登録するインターフェイスの IID へのポインター。
rclsid	GUID*	in	riid で指定されたカスタムインターフェイス用のプロキシ/スタブコードを含む DLL の CLSID へのポインター。

戻り値の型: HRESULT

公式ドキュメント

ダウンロードされた DLL が、実行中のプロセス内でカスタムインターフェイスを登録できるようにし、マーシャリングコードがそれらのインターフェイスをマーシャリングできるようにします。

戻り値

この関数は、標準的な戻り値である E_INVALIDARG、E_OUTOFMEMORY、および S_OK を返すことがあります。

解説(Remarks)

通常、インターフェイスポインターを現在実行中のプロセスへマーシャリングする処理を担うコードは、レジストリの HKEY_CLASSES_ROOT\Interfaces セクションを読み取り、読み込むべき ProxyStub コードを含む DLL の CLSID を取得します。既存のインターフェイスの ProxyStub CLSID を取得するには、コードは CoGetPSClsid 関数を呼び出します。

しかし場合によっては、インプロセスハンドラーまたはインプロセスサーバーが、レジストリへの書き込みを行わずにカスタムインターフェイスを利用可能にすることが望ましい、または必要なことがあります。ネットワーク経由でダウンロードされた DLL は、ローカルレジストリにアクセスする権限すら持っていないことがあり、またコードが別のコンピューターを起源とするため、ユーザーはセキュリティ上の理由から制限された環境で実行したい場合があります。あるいは、DLL がリモートサーバーと通信するために使用するカスタムインターフェイスを持ち、それらのインターフェイス用の ProxyStub コードを併せて含んでいる場合もあります。このような場合、DLL はインターフェイスを登録する代替手段を必要とします。CoRegisterPSClsid は、CoRegisterClassObject と組み合わせて使用することで、その代替手段を提供します。

例

DLL は通常、次のコード断片に示すように CoRegisterPSClsid を呼び出します。

HRESULT RegisterMyCustomInterface(DWORD *pdwRegistrationKey)
{
    HRESULT hr = CoRegisterClassObject(CLSID_MyProxyStubClsid,
        pIPSFactoryBuffer,
        CLSCTX_INPROC_SERVER,
        REGCLS_MULTIPLEUSE
        pdwRegistrationKey);
    if(SUCCEEDED)(hr))
    {
        hr = CoRegisterPSClsid(IID_MyCustomInterface, CLSID_MyProxyStubClsid);
    }
 
    return hr;
}

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

各言語での呼び出し定義

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

HRESULT CoRegisterPSClsid(
    const GUID* riid,
    const GUID* rclsid
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoRegisterPSClsid(
    ref Guid riid,   // GUID*
    ref Guid rclsid   // GUID*
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoRegisterPSClsid(
    ByRef riid As Guid,   ' GUID*
    ByRef rclsid As Guid   ' GUID*
) As Integer
End Function

' riid : GUID*
' rclsid : GUID*
Declare PtrSafe Function CoRegisterPSClsid Lib "ole32" ( _
    ByVal riid As LongPtr, _
    ByVal rclsid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CoRegisterPSClsid = ctypes.windll.ole32.CoRegisterPSClsid
CoRegisterPSClsid.restype = ctypes.c_int
CoRegisterPSClsid.argtypes = [
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # rclsid : GUID*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoRegisterPSClsid = Fiddle::Function.new(
  lib['CoRegisterPSClsid'],
  [
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn CoRegisterPSClsid(
        riid: *const GUID,  // GUID*
        rclsid: *const GUID  // GUID*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoRegisterPSClsid(ref Guid riid, ref Guid rclsid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoRegisterPSClsid' -Namespace Win32 -PassThru
# $api::CoRegisterPSClsid(riid, rclsid)

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

出力引数:

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