FindExecutableW

関数

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

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

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HINSTANCE FindExecutableW(
    LPCWSTR lpFile,
    LPCWSTR lpDirectory,   // optional
    LPWSTR lpResult
);

パラメーター

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

戻り値の型: HINSTANCE

公式ドキュメント

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

戻り値

型: 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)サーバーのパスが格納されることがあります。

メモ

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  (Unicode / -W)
#include <windows.h>

HINSTANCE FindExecutableW(
    LPCWSTR lpFile,
    LPCWSTR lpDirectory,   // optional
    LPWSTR lpResult
);

[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr FindExecutableW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFile,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpDirectory,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpResult   // LPWSTR out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function FindExecutableW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFile As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpDirectory As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpResult As System.Text.StringBuilder   ' LPWSTR out
) As IntPtr
End Function

' lpFile : LPCWSTR
' lpDirectory : LPCWSTR optional
' lpResult : LPWSTR out
Declare PtrSafe Function FindExecutableW Lib "shell32" ( _
    ByVal lpFile As LongPtr, _
    ByVal lpDirectory As LongPtr, _
    ByVal lpResult As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindExecutableW = ctypes.windll.shell32.FindExecutableW
FindExecutableW.restype = ctypes.c_void_p
FindExecutableW.argtypes = [
    wintypes.LPCWSTR,  # lpFile : LPCWSTR
    wintypes.LPCWSTR,  # lpDirectory : LPCWSTR optional
    wintypes.LPWSTR,  # lpResult : LPWSTR out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
FindExecutableW = Fiddle::Function.new(
  lib['FindExecutableW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFile : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpDirectory : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpResult : LPWSTR out
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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