Win32 API 日本語リファレンス
ホームUI.Shell › SHGetInstanceExplorer

SHGetInstanceExplorer

関数
ホストするエクスプローラーのIUnknownを取得する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHGetInstanceExplorer(
    IUnknown** ppunk
);

パラメーター

名前方向説明
ppunkIUnknown**outこの関数が正常に返ると、ホストプロセスの IUnknown インターフェイスポインターのアドレスが格納されます。これは、ホストプロセスの終了を防ぐために使用されるフリースレッドインターフェイスです。関数の呼び出しが失敗した場合、この値は NULL に設定されます。

戻り値の型: HRESULT

公式ドキュメント

ホストされた Shell 拡張機能やその他のコンポーネントが、ホストプロセスの早期終了を防ぐためのインターフェイスを取得します。

戻り値

型: HRESULT

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

解説(Remarks)

Shell 拡張機能ハンドラーなど、DLL として実装され、Windows Explorer (Explorer.exe) や Internet Explorer (Iexplore.exe) などのホストプロセス内で実行されるコンポーネントが数多く存在します。通常、ユーザーがホストプロセスを閉じると、コンポーネントも直ちにシャットダウンされます。このような突然の終了は、一部のコンポーネントに問題を引き起こす可能性があります。たとえば、コンポーネントがバックグラウンドスレッドを使用してデータをダウンロードしたり、ユーザーインターフェイス機能を実行したりしている場合、安全にシャットダウンするために追加の時間が必要になることがあります。

SHGetInstanceExplorer を使用すると、ホストプロセス内で実行されるコンポーネントが、ホストプロセスへの参照を保持できます。SHGetInstanceExplorer はホストの参照カウントをインクリメントし、ホストの IUnknown インターフェイスへのポインターを返します。この参照を保持することで、コンポーネントはホストプロセスの早期終了を防ぐことができます。コンポーネントが必要な処理を完了した後は、(*ppunk)->Release を呼び出してホストの参照を解放し、プロセスを終了できるようにする必要があります。

注意 SHGetInstanceExplorer が成功した場合、コンポーネントは不要になった時点でホストの参照を解放する必要があります。そうしないと、プロセスに関連付けられたすべてのリソースがメモリに残ったままになります。*ppunk が指す IUnknown インターフェイスは、この参照を解放するためにのみ使用できます。コンポーネントは (*ppunk)->QueryInterface を使用して他のインターフェイスポインターを要求することはできません。
SHGetInstanceExplorer は、以前に SHSetInstanceExplorer を呼び出してプロセス参照を設定したアプリケーションから呼び出された場合にのみ成功します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT SHGetInstanceExplorer(
    IUnknown** ppunk
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetInstanceExplorer(
    IntPtr ppunk   // IUnknown** out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetInstanceExplorer(
    ppunk As IntPtr   ' IUnknown** out
) As Integer
End Function
' ppunk : IUnknown** out
Declare PtrSafe Function SHGetInstanceExplorer Lib "shell32" ( _
    ByVal ppunk As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetInstanceExplorer = ctypes.windll.shell32.SHGetInstanceExplorer
SHGetInstanceExplorer.restype = ctypes.c_int
SHGetInstanceExplorer.argtypes = [
    ctypes.c_void_p,  # ppunk : IUnknown** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetInstanceExplorer = Fiddle::Function.new(
  lib['SHGetInstanceExplorer'],
  [
    Fiddle::TYPE_VOIDP,  # ppunk : IUnknown** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHGetInstanceExplorer(
        ppunk: *mut *mut core::ffi::c_void  // IUnknown** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetInstanceExplorer(IntPtr ppunk);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetInstanceExplorer' -Namespace Win32 -PassThru
# $api::SHGetInstanceExplorer(ppunk)
#uselib "SHELL32.dll"
#func global SHGetInstanceExplorer "SHGetInstanceExplorer" sptr
; SHGetInstanceExplorer ppunk   ; 戻り値は stat
; ppunk : IUnknown** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHGetInstanceExplorer "SHGetInstanceExplorer" sptr
; res = SHGetInstanceExplorer(ppunk)
; ppunk : IUnknown** out -> "sptr"
; HRESULT SHGetInstanceExplorer(IUnknown** ppunk)
#uselib "SHELL32.dll"
#cfunc global SHGetInstanceExplorer "SHGetInstanceExplorer" intptr
; res = SHGetInstanceExplorer(ppunk)
; ppunk : IUnknown** out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetInstanceExplorer = shell32.NewProc("SHGetInstanceExplorer")
)

// ppunk (IUnknown** out)
r1, _, err := procSHGetInstanceExplorer.Call(
	uintptr(ppunk),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHGetInstanceExplorer(
  ppunk: Pointer   // IUnknown** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetInstanceExplorer';
result := DllCall("SHELL32\SHGetInstanceExplorer"
    , "Ptr", ppunk   ; IUnknown** out
    , "Int")   ; return: HRESULT
●SHGetInstanceExplorer(ppunk) = DLL("SHELL32.dll", "int SHGetInstanceExplorer(void*)")
# 呼び出し: SHGetInstanceExplorer(ppunk)
# ppunk : IUnknown** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHGetInstanceExplorer(
    ppunk: ?*anyopaque // IUnknown** out
) callconv(std.os.windows.WINAPI) i32;
proc SHGetInstanceExplorer(
    ppunk: pointer  # IUnknown** out
): int32 {.importc: "SHGetInstanceExplorer", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHGetInstanceExplorer(
    void* ppunk   // IUnknown** out
);
ccall((:SHGetInstanceExplorer, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      ppunk)
# ppunk : IUnknown** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetInstanceExplorer(
    void* ppunk);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetInstanceExplorer(ppunk)
-- ppunk : IUnknown** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetInstanceExplorer = lib.func('__stdcall', 'SHGetInstanceExplorer', 'int32_t', ['void *']);
// SHGetInstanceExplorer(ppunk)
// ppunk : IUnknown** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHGetInstanceExplorer: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.SHGetInstanceExplorer(ppunk)
// ppunk : IUnknown** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetInstanceExplorer(
    void* ppunk);
C, "SHELL32.dll");
// $ffi->SHGetInstanceExplorer(ppunk);
// ppunk : IUnknown** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    int SHGetInstanceExplorer(
        Pointer ppunk   // IUnknown** out
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHGetInstanceExplorer = SHGetInstanceExplorer(
    ppunk : Void*   # IUnknown** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHGetInstanceExplorerNative = Int32 Function(Pointer<Void>);
typedef SHGetInstanceExplorerDart = int Function(Pointer<Void>);
final SHGetInstanceExplorer = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetInstanceExplorerNative, SHGetInstanceExplorerDart>('SHGetInstanceExplorer');
// ppunk : IUnknown** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetInstanceExplorer(
  ppunk: Pointer   // IUnknown** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetInstanceExplorer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetInstanceExplorer"
  c_SHGetInstanceExplorer :: Ptr () -> IO Int32
-- ppunk : IUnknown** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetinstanceexplorer =
  foreign "SHGetInstanceExplorer"
    ((ptr void) @-> returning int32_t)
(* ppunk : IUnknown** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHGetInstanceExplorer" shget-instance-explorer :convention :stdcall) :int32
  (ppunk :pointer))   ; IUnknown** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetInstanceExplorer = Win32::API::More->new('SHELL32',
    'int SHGetInstanceExplorer(LPVOID ppunk)');
# my $ret = $SHGetInstanceExplorer->Call($ppunk);
# ppunk : IUnknown** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型