ShellExecuteExA

関数

指定したファイルやプログラムをシェル経由で実行する。

DLLSHELL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

BOOL ShellExecuteExA(
    SHELLEXECUTEINFOA* pExecInfo
);

パラメーター

名前	型	方向	説明
pExecInfo	SHELLEXECUTEINFOA*	inout	実行するアプリケーションに関する情報を格納し、受け取る SHELLEXECUTEINFO 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

指定したファイルに対して操作を実行します。(ShellExecuteExA)

戻り値

型: BOOL

成功した場合は TRUE を、それ以外の場合は FALSE を返します。詳細なエラー情報を取得するには GetLastError を呼び出してください。

解説(Remarks)

ShellExecuteEx は、Component Object Model (COM) を使用してアクティブ化される Shell 拡張機能(データソース、コンテキストメニューハンドラー、動詞の実装)に実行を委譲することがあるため、ShellExecuteEx を呼び出す前に COM を初期化しておく必要があります。一部の Shell 拡張機能は COM のシングルスレッドアパートメント (STA) タイプを必要とします。その場合、COM は次のように初期化する必要があります。

CoInitializeEx(NULL, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE)

ShellExecuteEx がこれらのタイプの Shell 拡張機能を使用しない場合もあり、その場合は COM を初期化する必要はまったくありません。とはいえ、この関数を使用する前には常に COM を初期化しておくことが良い習慣です。

DLL がプロセスに読み込まれると、ローダーロックと呼ばれるロックを取得します。DllMain 関数は常にローダーロックの下で実行されます。ローダーロックを保持している間は ShellExecuteEx を呼び出さないことが重要です。ShellExecuteEx は拡張可能であるため、ローダーロックが存在する状況で正しく動作しないコードを読み込む可能性があり、デッドロックを引き起こしてスレッドが応答しなくなる危険性があります。

複数のモニターを使用している場合、HWND を指定し、lpExecInfo が指す SHELLEXECUTEINFO 構造体の lpVerb メンバーを "Properties" に設定すると、ShellExecuteEx によって作成されるウィンドウが正しい位置に表示されないことがあります。

関数が成功した場合、SHELLEXECUTEINFO 構造体の hInstApp メンバーに 32 より大きい値が設定されます。関数が失敗した場合、hInstApp には失敗の原因を最もよく示す SE_ERR_XXX エラー値が設定されます。hInstApp は 16 ビット Windows アプリケーションとの互換性のために HINSTANCE として宣言されていますが、真の HINSTANCE ではありません。int にのみキャストでき、値 32 または SE_ERR_XXX エラーコードとのみ比較できます。

SE_ERR_XXX エラー値は ShellExecute との互換性のために提供されています。より正確なエラー情報を取得するには GetLastError を使用してください。次のいずれかの値が返される場合があります。

エラー	説明
ERROR_FILE_NOT_FOUND	指定したファイルが見つかりませんでした。
ERROR_PATH_NOT_FOUND	指定したパスが見つかりませんでした。
ERROR_DDE_FAIL	動的データ交換 (DDE) トランザクションが失敗しました。
ERROR_NO_ASSOCIATION	指定したファイル名拡張子に関連付けられたアプリケーションがありません。
ERROR_ACCESS_DENIED	指定したファイルへのアクセスが拒否されました。
ERROR_DLL_NOT_FOUND	アプリケーションの実行に必要なライブラリファイルの 1 つが見つかりません。
ERROR_CANCELLED	関数がユーザーに追加情報の入力を求めましたが、ユーザーが要求をキャンセルしました。
ERROR_NOT_ENOUGH_MEMORY	指定した操作を実行するのに十分なメモリがありません。
ERROR_SHARING_VIOLATION	共有違反が発生しました。

URL からの項目のオープン アプリケーションを、URL が渡されたときにアクティブ化するように登録できます。また、アプリケーションがサポートするプロトコルを指定することもできます。詳細については Application Registration を参照してください。

サイトチェーンのサポート Windows 8 以降では、ShellExecuteEx 関数にサイトチェーンポインターを指定して、そのサイトのサービスを使用した項目のアクティブ化をサポートできます。詳細については Launching Applications (ShellExecute, ShellExecuteEx, SHELLEXECUTEINFO) を参照してください。

メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ShellExecuteEx を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

BOOL ShellExecuteExA(
    SHELLEXECUTEINFOA* pExecInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ShellExecuteExA(
    IntPtr pExecInfo   // SHELLEXECUTEINFOA* in/out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ShellExecuteExA(
    pExecInfo As IntPtr   ' SHELLEXECUTEINFOA* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pExecInfo : SHELLEXECUTEINFOA* in/out
Declare PtrSafe Function ShellExecuteExA Lib "shell32" ( _
    ByVal pExecInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ShellExecuteExA = ctypes.windll.shell32.ShellExecuteExA
ShellExecuteExA.restype = wintypes.BOOL
ShellExecuteExA.argtypes = [
    ctypes.c_void_p,  # pExecInfo : SHELLEXECUTEINFOA* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
ShellExecuteExA = Fiddle::Function.new(
  lib['ShellExecuteExA'],
  [
    Fiddle::TYPE_VOIDP,  # pExecInfo : SHELLEXECUTEINFOA* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn ShellExecuteExA(
        pExecInfo: *mut SHELLEXECUTEINFOA  // SHELLEXECUTEINFOA* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool ShellExecuteExA(IntPtr pExecInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_ShellExecuteExA' -Namespace Win32 -PassThru
# $api::ShellExecuteExA(pExecInfo)

#uselib "SHELL32.dll"
#func global ShellExecuteExA "ShellExecuteExA" sptr
; ShellExecuteExA varptr(pExecInfo)   ; 戻り値は stat
; pExecInfo : SHELLEXECUTEINFOA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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