ProgIDFromCLSID

関数

CLSIDから対応するProgID文字列を取得する。

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

シグネチャ

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

HRESULT ProgIDFromCLSID(
    const GUID* clsid,
    LPWSTR* lplpszProgID
);

パラメーター

名前	型	方向	説明
clsid	GUID*	in	ProgID を要求する対象の CLSID。
lplpszProgID	LPWSTR*	out	ProgID 文字列を受け取るポインター変数のアドレス。clsid を表す文字列には、囲みの波かっこが含まれます。

戻り値の型: HRESULT

公式ドキュメント

指定された CLSID に対応する ProgID を取得します。

戻り値

この関数は次の値を返すことがあります。

戻り値	説明
S_OK	ProgID が正常に返されました。
REGDB_E_CLASSNOTREG	クラスがレジストリに登録されていません。
REGDB_E_READREGDB	レジストリの読み取り中にエラーが発生しました。

解説(Remarks)

オブジェクトの挿入ダイアログボックスに表示されるすべての OLE オブジェクトクラスは、プログラム識別子 (ProgID) を持つ必要があります。ProgID は特定のクラスを一意に識別する文字列で、レジストリに格納されます。ProgID は、オブジェクトの挿入ダイアログボックスへの掲載資格を判定するほか、マクロプログラミング言語においてクラスを識別する識別子として使用できます。さらに ProgID は、OLE 1 コンテナーに配置される OLE クラスのオブジェクトに使用されるクラス名でもあります。

ProgIDFromCLSID は、変換を行うためにレジストリのエントリを使用します。OLE アプリケーションの作成者は、アプリケーションのセットアッププログラムでレジストリが正しく構成されるようにする責任があります。

ProgID 文字列は、いずれの OLE 1 アプリケーションのクラス名とも異なっている必要があります。これには、同一アプリケーションの OLE 1 バージョンが存在する場合、そのクラス名も含まれます。さらに ProgID 文字列は、39 文字を超えてはならず、数字で始まってはならず、また 1 つのピリオドを除いて句読記号 (アンダースコアを含む) を含んではなりません。

ProgID をユーザーインターフェイス上でユーザーに表示してはなりません。オブジェクトに対して表示可能な短い文字列が必要な場合は、IOleObject::GetUserType を呼び出してください。

指定された ProgID に関連付けられた CLSID を見つけるには、CLSIDFromProgID 関数を呼び出します。返された ProgID を使い終わったら、必ず CoTaskMemFree 関数を呼び出して解放してください。

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

各言語での呼び出し定義

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

HRESULT ProgIDFromCLSID(
    const GUID* clsid,
    LPWSTR* lplpszProgID
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int ProgIDFromCLSID(
    ref Guid clsid,   // GUID*
    IntPtr lplpszProgID   // LPWSTR* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function ProgIDFromCLSID(
    ByRef clsid As Guid,   ' GUID*
    lplpszProgID As IntPtr   ' LPWSTR* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

ProgIDFromCLSID = ctypes.windll.ole32.ProgIDFromCLSID
ProgIDFromCLSID.restype = ctypes.c_int
ProgIDFromCLSID.argtypes = [
    ctypes.c_void_p,  # clsid : GUID*
    ctypes.c_void_p,  # lplpszProgID : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
ProgIDFromCLSID = Fiddle::Function.new(
  lib['ProgIDFromCLSID'],
  [
    Fiddle::TYPE_VOIDP,  # clsid : GUID*
    Fiddle::TYPE_VOIDP,  # lplpszProgID : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn ProgIDFromCLSID(
        clsid: *const GUID,  // GUID*
        lplpszProgID: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int ProgIDFromCLSID(ref Guid clsid, IntPtr lplpszProgID);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_ProgIDFromCLSID' -Namespace Win32 -PassThru
# $api::ProgIDFromCLSID(clsid, lplpszProgID)

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

出力引数:

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