SearchPathA

関数

指定パスから条件に合うファイルを検索しフルパスを取得する(ANSI版)。

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

シグネチャ

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

DWORD SearchPathA(
    LPCSTR lpPath,   // optional
    LPCSTR lpFileName,
    LPCSTR lpExtension,   // optional
    DWORD nBufferLength,
    LPSTR lpBuffer,   // optional
    LPSTR* lpFilePart   // optional
);

パラメーター

名前	型	方向	説明
lpPath	LPCSTR	inoptional	ファイルを検索するパス。このパラメーターが NULL の場合、関数はレジストリに依存するシステム検索パスを使用して、一致するファイルを検索します。詳細については、「解説」セクションを参照してください。
lpFileName	LPCSTR	in	検索対象のファイル名。既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。ヒント Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を取り除くようにオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。
lpExtension	LPCSTR	inoptional	ファイルを検索する際にファイル名に追加する拡張子。ファイル名の拡張子の最初の文字はピリオド (.) でなければなりません。拡張子は、指定したファイル名が拡張子で終わっていない場合にのみ追加されます。ファイル名の拡張子が不要な場合、またはファイル名に拡張子が含まれている場合、このパラメーターは NULL にできます。
nBufferLength	DWORD	in	有効なパスとファイル名(終端の null 文字を含む)を受け取るバッファーのサイズ(TCHAR 単位)。
lpBuffer	LPSTR	outoptional	見つかったファイルのパスとファイル名を受け取るバッファーへのポインター。文字列は null 終端文字列です。
lpFilePart	LPSTR*	outoptional	有効なパスとファイル名の最後のコンポーネントのアドレス(lpBuffer 内)を受け取る変数へのポインター。これは、パス内の最後の円記号 (\) の直後の文字のアドレスです。

戻り値の型: DWORD

公式ドキュメント

指定したパス内で指定したファイルを検索します。(ANSI)

戻り値

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ(TCHAR 単位、終端の null 文字を含まない)です。戻り値が nBufferLength より大きい場合、戻り値はパスを保持するために必要なバッファーのサイズ(終端の null 文字を含む)です。

関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

lpPath パラメーターが NULL の場合、SearchPath は次のレジストリ値の現在の値に基づいて一致するファイルを検索します。

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\SafeProcessSearchMode

この REG_DWORD レジストリ値が 1 に設定されている場合、SearchPath はまずシステムパスで指定されたフォルダーを検索し、次に現在の作業フォルダーを検索します。このレジストリ値が 0 に設定されている場合、コンピューターはまず現在の作業フォルダーを検索し、次にシステムパスで指定されたフォルダーを検索します。このレジストリキーのシステム既定値は 0 です。

SearchPath 関数で使用される検索モードは、SetSearchPathMode 関数を呼び出すことによってプロセスごとに設定することもできます。

出力を LoadLibrary 関数の呼び出しで使用する予定がある場合、.dll ファイルを特定する方法として SearchPath 関数は推奨されません。SearchPath 関数の検索順序は LoadLibrary 関数で使用される検索順序と異なるため、誤った .dll ファイルが特定される可能性があります。.dll ファイルを特定して読み込む必要がある場合は、LoadLibrary 関数を使用してください。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 Transparent Failover (TFO)	はい
SMB 3.0 with Scale-out File Shares (SO)	はい
Cluster Shared Volume File System (CsvFS)	はい
Resilient File System (ReFS)	はい

メモ

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

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

各言語での呼び出し定義

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

DWORD SearchPathA(
    LPCSTR lpPath,   // optional
    LPCSTR lpFileName,
    LPCSTR lpExtension,   // optional
    DWORD nBufferLength,
    LPSTR lpBuffer,   // optional
    LPSTR* lpFilePart   // optional
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint SearchPathA(
    [MarshalAs(UnmanagedType.LPStr)] string lpPath,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpExtension,   // LPCSTR optional
    uint nBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer,   // LPSTR optional, out
    IntPtr lpFilePart   // LPSTR* optional, out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SearchPathA(
    <MarshalAs(UnmanagedType.LPStr)> lpPath As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpExtension As String,   ' LPCSTR optional
    nBufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    lpFilePart As IntPtr   ' LPSTR* optional, out
) As UInteger
End Function

' lpPath : LPCSTR optional
' lpFileName : LPCSTR
' lpExtension : LPCSTR optional
' nBufferLength : DWORD
' lpBuffer : LPSTR optional, out
' lpFilePart : LPSTR* optional, out
Declare PtrSafe Function SearchPathA Lib "kernel32" ( _
    ByVal lpPath As String, _
    ByVal lpFileName As String, _
    ByVal lpExtension As String, _
    ByVal nBufferLength As Long, _
    ByVal lpBuffer As String, _
    ByVal lpFilePart As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SearchPathA = ctypes.windll.kernel32.SearchPathA
SearchPathA.restype = wintypes.DWORD
SearchPathA.argtypes = [
    wintypes.LPCSTR,  # lpPath : LPCSTR optional
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.LPCSTR,  # lpExtension : LPCSTR optional
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.LPSTR,  # lpBuffer : LPSTR optional, out
    ctypes.c_void_p,  # lpFilePart : LPSTR* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SearchPathA = Fiddle::Function.new(
  lib['SearchPathA'],
  [
    Fiddle::TYPE_VOIDP,  # lpPath : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpExtension : LPCSTR optional
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpFilePart : LPSTR* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SearchPathA(
        lpPath: *const u8,  // LPCSTR optional
        lpFileName: *const u8,  // LPCSTR
        lpExtension: *const u8,  // LPCSTR optional
        nBufferLength: u32,  // DWORD
        lpBuffer: *mut u8,  // LPSTR optional, out
        lpFilePart: *mut *mut u8  // LPSTR* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern uint SearchPathA([MarshalAs(UnmanagedType.LPStr)] string lpPath, [MarshalAs(UnmanagedType.LPStr)] string lpFileName, [MarshalAs(UnmanagedType.LPStr)] string lpExtension, uint nBufferLength, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer, IntPtr lpFilePart);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SearchPathA' -Namespace Win32 -PassThru
# $api::SearchPathA(lpPath, lpFileName, lpExtension, nBufferLength, lpBuffer, lpFilePart)

#uselib "KERNEL32.dll"
#func global SearchPathA "SearchPathA" sptr, sptr, sptr, sptr, sptr, sptr
; SearchPathA lpPath, lpFileName, lpExtension, nBufferLength, varptr(lpBuffer), varptr(lpFilePart)   ; 戻り値は stat
; lpPath : LPCSTR optional -> "sptr"
; lpFileName : LPCSTR -> "sptr"
; lpExtension : LPCSTR optional -> "sptr"
; nBufferLength : DWORD -> "sptr"
; lpBuffer : LPSTR optional, out -> "sptr"
; lpFilePart : LPSTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SearchPathA "SearchPathA" str, str, str, int, var, var
; res = SearchPathA(lpPath, lpFileName, lpExtension, nBufferLength, lpBuffer, lpFilePart)
; lpPath : LPCSTR optional -> "str"
; lpFileName : LPCSTR -> "str"
; lpExtension : LPCSTR optional -> "str"
; nBufferLength : DWORD -> "int"
; lpBuffer : LPSTR optional, out -> "var"
; lpFilePart : LPSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global SearchPathA "SearchPathA" str, str, str, int, sptr, sptr
; res = SearchPathA(lpPath, lpFileName, lpExtension, nBufferLength, varptr(lpBuffer), varptr(lpFilePart))
; lpPath : LPCSTR optional -> "str"
; lpFileName : LPCSTR -> "str"
; lpExtension : LPCSTR optional -> "str"
; nBufferLength : DWORD -> "int"
; lpBuffer : LPSTR optional, out -> "sptr"
; lpFilePart : LPSTR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。