SearchPathW

関数

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

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

シグネチャ

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

DWORD SearchPathW(
    LPCWSTR lpPath,   // optional
    LPCWSTR lpFileName,
    LPCWSTR lpExtension,   // optional
    DWORD nBufferLength,
    LPWSTR lpBuffer,   // optional
    LPWSTR* lpFilePart   // optional
);

パラメーター

名前	型	方向	説明
lpPath	LPCWSTR	inoptional	ファイルを検索するパスです。このパラメーターが NULL の場合、関数はレジストリに依存するシステム検索パスを使用して、一致するファイルを検索します。詳細については、「解説」セクションを参照してください。
lpFileName	LPCWSTR	in	検索対象のファイルの名前です。
lpExtension	LPCWSTR	inoptional	ファイルを検索する際にファイル名に追加される拡張子です。ファイル名拡張子の最初の文字はピリオド (.) でなければなりません。拡張子は、指定されたファイル名が拡張子で終わっていない場合にのみ追加されます。ファイル名拡張子が不要な場合、またはファイル名に拡張子が含まれている場合、このパラメーターは NULL にできます。
nBufferLength	DWORD	in	有効なパスとファイル名 (終端の null 文字を含む) を受け取るバッファーのサイズです。単位は TCHAR です。
lpBuffer	LPWSTR	outoptional	見つかったファイルのパスとファイル名を受け取るバッファーへのポインターです。文字列は null で終端されます。
lpFilePart	LPWSTR*	outoptional	有効なパスとファイル名の最後の要素のアドレス (lpBuffer 内) を受け取る変数へのポインターです。これはパス内の最後のバックスラッシュ (\) の直後の文字のアドレスです。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、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 10 バージョン 1607 以降では、この関数の Unicode バージョン (SearchPathW) について、MAX_PATH の制限を解除するようにオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「最大パス長の制限」セクションを参照してください。

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

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

各言語での呼び出し定義

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

DWORD SearchPathW(
    LPCWSTR lpPath,   // optional
    LPCWSTR lpFileName,
    LPCWSTR lpExtension,   // optional
    DWORD nBufferLength,
    LPWSTR lpBuffer,   // optional
    LPWSTR* lpFilePart   // optional
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint SearchPathW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpPath,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpExtension,   // LPCWSTR optional
    uint nBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR optional, out
    IntPtr lpFilePart   // LPWSTR* optional, out
);

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

' lpPath : LPCWSTR optional
' lpFileName : LPCWSTR
' lpExtension : LPCWSTR optional
' nBufferLength : DWORD
' lpBuffer : LPWSTR optional, out
' lpFilePart : LPWSTR* optional, out
Declare PtrSafe Function SearchPathW Lib "kernel32" ( _
    ByVal lpPath As LongPtr, _
    ByVal lpFileName As LongPtr, _
    ByVal lpExtension As LongPtr, _
    ByVal nBufferLength As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal lpFilePart As LongPtr) As Long
' 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SearchPathW = Fiddle::Function.new(
  lib['SearchPathW'],
  [
    Fiddle::TYPE_VOIDP,  # lpPath : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpExtension : LPCWSTR optional
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpFilePart : LPWSTR* optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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