ホーム › UI.Shell › SHCoCreateInstance

SHCoCreateInstance

関数

CLSIDからシェルCOMオブジェクトを生成する。

DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHCoCreateInstance(
    LPCWSTR pszCLSID,   // optional
    const GUID* pclsid,   // optional
    IUnknown* pUnkOuter,   // optional
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
pszCLSID	LPCWSTR	inoptional	CLSID に変換する文字列へのポインター。NULL の場合、pclsid が CLSID として使用されます。
pclsid	GUID*	inoptional	作成する CLSID。
pUnkOuter	IUnknown*	inoptional	外部 IUnknown へのポインター。アグリゲーションに使用されます。
riid	GUID*	in	ppv を通じて取得するインターフェイスの IID への参照。
ppv	void**	out	この関数が正常に終了すると、riid で要求されたインターフェイスポインターを受け取ります。

戻り値の型: HRESULT

公式ドキュメント

SHCoCreateInstance は変更されるか、利用できなくなる可能性があります。代わりに CoCreateInstance を使用してください。

戻り値

型: HRESULT

この関数が成功すると、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

解説(Remarks)

riid パラメーターと ppv パラメーターをまとめるには、Objbase.h で定義されている IID_PPV_ARGS マクロを使用することをお勧めします。このマクロは、ppv の値が指すインターフェイスに基づいて正しい IID を提供します。これにより、riid のコーディングミスによって予期しない結果が生じる可能性を排除できます。

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

各言語での呼び出し定義

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

HRESULT SHCoCreateInstance(
    LPCWSTR pszCLSID,   // optional
    const GUID* pclsid,   // optional
    IUnknown* pUnkOuter,   // optional
    const GUID* riid,
    void** ppv
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCoCreateInstance(
    [MarshalAs(UnmanagedType.LPWStr)] string pszCLSID,   // LPCWSTR optional
    IntPtr pclsid,   // GUID* optional
    IntPtr pUnkOuter,   // IUnknown* optional
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCoCreateInstance(
    <MarshalAs(UnmanagedType.LPWStr)> pszCLSID As String,   ' LPCWSTR optional
    pclsid As IntPtr,   ' GUID* optional
    pUnkOuter As IntPtr,   ' IUnknown* optional
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' pszCLSID : LPCWSTR optional
' pclsid : GUID* optional
' pUnkOuter : IUnknown* optional
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHCoCreateInstance Lib "shell32" ( _
    ByVal pszCLSID As LongPtr, _
    ByVal pclsid As LongPtr, _
    ByVal pUnkOuter As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHCoCreateInstance = ctypes.windll.shell32.SHCoCreateInstance
SHCoCreateInstance.restype = ctypes.c_int
SHCoCreateInstance.argtypes = [
    wintypes.LPCWSTR,  # pszCLSID : LPCWSTR optional
    ctypes.c_void_p,  # pclsid : GUID* optional
    ctypes.c_void_p,  # pUnkOuter : IUnknown* optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCoCreateInstance = Fiddle::Function.new(
  lib['SHCoCreateInstance'],
  [
    Fiddle::TYPE_VOIDP,  # pszCLSID : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pclsid : GUID* optional
    Fiddle::TYPE_VOIDP,  # pUnkOuter : IUnknown* optional
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHCoCreateInstance(
        pszCLSID: *const u16,  // LPCWSTR optional
        pclsid: *const GUID,  // GUID* optional
        pUnkOuter: *mut core::ffi::c_void,  // IUnknown* optional
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHCoCreateInstance([MarshalAs(UnmanagedType.LPWStr)] string pszCLSID, IntPtr pclsid, IntPtr pUnkOuter, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCoCreateInstance' -Namespace Win32 -PassThru
# $api::SHCoCreateInstance(pszCLSID, pclsid, pUnkOuter, riid, ppv)

#uselib "SHELL32.dll"
#func global SHCoCreateInstance "SHCoCreateInstance" sptr, sptr, sptr, sptr, sptr
; SHCoCreateInstance pszCLSID, varptr(pclsid), pUnkOuter, varptr(riid), ppv   ; 戻り値は stat
; pszCLSID : LPCWSTR optional -> "sptr"
; pclsid : GUID* optional -> "sptr"
; pUnkOuter : IUnknown* optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHCoCreateInstance "SHCoCreateInstance" wstr, var, sptr, var, sptr
; res = SHCoCreateInstance(pszCLSID, pclsid, pUnkOuter, riid, ppv)
; pszCLSID : LPCWSTR optional -> "wstr"
; pclsid : GUID* optional -> "var"
; pUnkOuter : IUnknown* optional -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHCoCreateInstance "SHCoCreateInstance" wstr, sptr, sptr, sptr, sptr
; res = SHCoCreateInstance(pszCLSID, varptr(pclsid), pUnkOuter, varptr(riid), ppv)
; pszCLSID : LPCWSTR optional -> "wstr"
; pclsid : GUID* optional -> "sptr"
; pUnkOuter : IUnknown* optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。