FindExecutableA

関数

ファイル(ANSI)に関連付けられた実行ファイルを検索する。

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

シグネチャ

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

HINSTANCE FindExecutableA(
    LPCSTR lpFile,
    LPCSTR lpDirectory,   // optional
    LPSTR lpResult
);

パラメーター

名前	型	方向	説明
lpFile	LPCSTR	in	ファイル名を指定する null 終端文字列のアドレス。このファイルはドキュメントである必要があります。
lpDirectory	LPCSTR	inoptional	既定のディレクトリを指定する null 終端文字列のアドレス。この値は NULL でもかまいません。
lpResult	LPSTR	out	関連付けられた実行可能ファイルのファイル名を受け取るバッファーのアドレス。このファイル名は null 終端文字列であり、lpFile パラメーターで指定されたファイルに対して関連付けによる ":::no-loc text="open":::" が実行されたときに起動される実行可能ファイルを指定します。簡単に言えば、これはドキュメントファイルを直接ダブルクリックしたとき、またはファイルのショートカットメニューから Open を選択したときに起動されるアプリケーションです。このパラメーターには有効な非 null 値を格納する必要があり、長さは MAX_PATH であると想定されます。値の検証はプログラマーの責任となります。

戻り値の型: HINSTANCE

公式ドキュメント

特定のドキュメントファイルに関連付けられた実行可能 (.exe) ファイルの名前とハンドルを取得します。(ANSI)

戻り値

型: HINSTANCE

成功した場合は 32 より大きい値を返し、失敗した場合はエラーを表す 32 以下の値を返します。

次の表に、発生し得るエラー値を示します。

戻りコード/値	説明
SE_ERR_FNF 2	指定されたファイルが見つかりませんでした。
SE_ERR_PNF 3	指定されたパスが無効です。
SE_ERR_ACCESSDENIED 5	指定されたファイルにアクセスできません。
SE_ERR_OOM 8	システムのメモリまたはリソースが不足しています。
SE_ERR_NOASSOC 31	指定されたファイルの種類に対して、実行可能ファイルとの関連付けがありません。

解説(Remarks)

ドキュメントには FindExecutable を使用してください。実行可能ファイルのパスを取得したい場合は、次を使用します。

AssocQueryString(ASSOCF_OPEN_BYEXENAME,
                 ASSOCSTR_EXECUTABLE,
                 pszExecutableName,
                 NULL,
                 pszPath,
                 pcchOut);

ここで、pszExecutableName は実行可能ファイルの名前を指定する null 終端文字列へのポインター、pszPath は実行可能ファイルへのパスを受け取る null 終端文字列バッファーへのポインター、pcchOut は pszPath バッファー内の文字数を指定する DWORD へのポインターです。関数が戻ると、pcchOut には実際にバッファーに格納された文字数が設定されます。詳細については AssocQueryString を参照してください。

FindExecutable が戻るとき、DDE クライアントアプリケーションとの DDE 会話を開始する要求にサーバーが応答しなかった場合、lpResult パラメーターには起動された動的データ交換 (DDE: Dynamic Data Exchange) サーバーへのパスが格納される場合があります。

メモ

shellapi.h ヘッダーは FindExecutable をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版が自動的に選択されます。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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>

HINSTANCE FindExecutableA(
    LPCSTR lpFile,
    LPCSTR lpDirectory,   // optional
    LPSTR lpResult
);

[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr FindExecutableA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFile,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpDirectory,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpResult   // LPSTR out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function FindExecutableA(
    <MarshalAs(UnmanagedType.LPStr)> lpFile As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpDirectory As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpResult As System.Text.StringBuilder   ' LPSTR out
) As IntPtr
End Function

' lpFile : LPCSTR
' lpDirectory : LPCSTR optional
' lpResult : LPSTR out
Declare PtrSafe Function FindExecutableA Lib "shell32" ( _
    ByVal lpFile As String, _
    ByVal lpDirectory As String, _
    ByVal lpResult As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindExecutableA = ctypes.windll.shell32.FindExecutableA
FindExecutableA.restype = ctypes.c_void_p
FindExecutableA.argtypes = [
    wintypes.LPCSTR,  # lpFile : LPCSTR
    wintypes.LPCSTR,  # lpDirectory : LPCSTR optional
    wintypes.LPSTR,  # lpResult : LPSTR out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
FindExecutableA = Fiddle::Function.new(
  lib['FindExecutableA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpDirectory : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpResult : LPSTR out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "shell32")]
extern "system" {
    fn FindExecutableA(
        lpFile: *const u8,  // LPCSTR
        lpDirectory: *const u8,  // LPCSTR optional
        lpResult: *mut u8  // LPSTR out
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr FindExecutableA([MarshalAs(UnmanagedType.LPStr)] string lpFile, [MarshalAs(UnmanagedType.LPStr)] string lpDirectory, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_FindExecutableA' -Namespace Win32 -PassThru
# $api::FindExecutableA(lpFile, lpDirectory, lpResult)

#uselib "SHELL32.dll"
#func global FindExecutableA "FindExecutableA" sptr, sptr, sptr
; FindExecutableA lpFile, lpDirectory, varptr(lpResult)   ; 戻り値は stat
; lpFile : LPCSTR -> "sptr"
; lpDirectory : LPCSTR optional -> "sptr"
; lpResult : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global FindExecutableA "FindExecutableA" str, str, var
; res = FindExecutableA(lpFile, lpDirectory, lpResult)
; lpFile : LPCSTR -> "str"
; lpDirectory : LPCSTR optional -> "str"
; lpResult : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global FindExecutableA "FindExecutableA" str, str, sptr
; res = FindExecutableA(lpFile, lpDirectory, varptr(lpResult))
; lpFile : LPCSTR -> "str"
; lpDirectory : LPCSTR optional -> "str"
; lpResult : LPSTR out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。