PathFindOnPathA

関数

指定ディレクトリ群を探索し、ファイルが見つかれば完全パスを設定する。

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

シグネチャ

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

BOOL PathFindOnPathA(
    LPSTR pszPath,
    CHAR** ppszOtherDirs   // optional
);

パラメーター

名前	型	方向	説明
pszPath	LPSTR	inout	検索対象のファイル名を含む、長さ MAX_PATH の null 終端文字列へのポインター。検索に成功した場合、このパラメーターには完全修飾されたパス名が返されます。
ppszOtherDirs	CHAR**	inoptional	最初に検索するディレクトリの、省略可能な null 終端配列です。この値は NULL でもかまいません。

戻り値の型: BOOL

公式ドキュメント

ファイルを検索します。(ANSI)

戻り値

型: BOOL

成功した場合は TRUE、それ以外の場合は FALSE を返します。

解説(Remarks)

PathFindOnPath は、pszFile で指定されたファイルを検索します。ppszOtherDirs でディレクトリが指定されていない場合、System32 などの標準ディレクトリや PATH 環境変数で指定されたディレクトリを検索してファイルを見つけようとします。処理を高速化したり、PathFindOnPath がより広範なディレクトリを検索できるようにするには、ppszOtherDirs パラメーターを使用して最初に検索する 1 つ以上のディレクトリを指定します。pszFile で指定された名前を持つファイルが複数存在する場合、PathFindOnPath は最初に見つかったものを返します。

メモ

shlwapi.h ヘッダーは PathFindOnPath をエイリアスとして定義しており、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)

各言語での呼び出し定義

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

BOOL PathFindOnPathA(
    LPSTR pszPath,
    CHAR** ppszOtherDirs   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathFindOnPathA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath,   // LPSTR in/out
    IntPtr ppszOtherDirs   // CHAR** optional
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathFindOnPathA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder,   ' LPSTR in/out
    ppszOtherDirs As IntPtr   ' CHAR** optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszPath : LPSTR in/out
' ppszOtherDirs : CHAR** optional
Declare PtrSafe Function PathFindOnPathA Lib "shlwapi" ( _
    ByVal pszPath As String, _
    ByVal ppszOtherDirs As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathFindOnPathA = ctypes.windll.shlwapi.PathFindOnPathA
PathFindOnPathA.restype = wintypes.BOOL
PathFindOnPathA.argtypes = [
    wintypes.LPSTR,  # pszPath : LPSTR in/out
    ctypes.c_void_p,  # ppszOtherDirs : CHAR** optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathFindOnPathA = Fiddle::Function.new(
  lib['PathFindOnPathA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR in/out
    Fiddle::TYPE_VOIDP,  # ppszOtherDirs : CHAR** optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn PathFindOnPathA(
        pszPath: *mut u8,  // LPSTR in/out
        ppszOtherDirs: *mut *mut i8  // CHAR** optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern bool PathFindOnPathA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath, IntPtr ppszOtherDirs);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathFindOnPathA' -Namespace Win32 -PassThru
# $api::PathFindOnPathA(pszPath, ppszOtherDirs)

#uselib "SHLWAPI.dll"
#func global PathFindOnPathA "PathFindOnPathA" sptr, sptr
; PathFindOnPathA varptr(pszPath), varptr(ppszOtherDirs)   ; 戻り値は stat
; pszPath : LPSTR in/out -> "sptr"
; ppszOtherDirs : CHAR** optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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