Win32 API 日本語リファレンス
ホームUI.Shell › PathResolve

PathResolve

関数
パスを解決し完全パスに変換する。
DLLSHELL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

INT PathResolve(
    LPWSTR pszPath,
    WORD** dirs,   // optional
    DWORD fFlags
);

パラメーター

名前方向説明
pszPathLPWSTRinout解決対象のパスを格納する、null 終端の Unicode 文字列です。関数が戻るとき、この文字列には対応する完全修飾パスが格納されます。このバッファーは少なくとも MAX_PATH 文字分の長さが必要です。
dirsWORD**inoptionalpszPath からパスを解決できなかった場合に最初に検索される、null 終端のディレクトリ配列(省略可能)へのポインターです。この値は NULL にできます。
fFlagsDWORDin

関数の動作方法を指定するフラグです。

PRF_VERIFYEXISTS

ファイルの存在が確認された場合は TRUE を返し、そうでない場合は FALSE を返します。

PRF_TRYPROGRAMEXTENSIONS

指定されたパスに対して、次の拡張子を付加して検索します: .pif、.com、.bat、.cmd、.lnk、.exe。

PRF_FIRSTDIRDEF

最初に dirs で指定されたディレクトリを検索します。

PRF_DONTFINDLNK

.lnk ファイルを無視します。

PRF_REQUIREABSOLUTE

絶対(完全)パスを必須とします。

戻り値の型: INT

公式ドキュメント

PathResolve は変更されるか、利用できなくなる可能性があります。

戻り値

型: int

PRF_VERIFYEXISTS が設定されていない限り、TRUE を返します。このフラグが設定されている場合、ファイルの存在が確認されると TRUE を、確認されないと FALSE を返します。また、GetLastError を呼び出して取得できる ERROR_FILE_NOT_FOUND エラー コードを設定します。

解説(Remarks)

FALSE の戻り値は、必ずしもファイルが存在しないことを意味するわけではありません。指定された情報からは単にファイルを見つけられなかったことを意味する場合もあります。

PathResolvepszPath で指定されたパスを解決できない場合、pszPathdirs をパラメーターとして PathFindOnPath を呼び出します。

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

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

INT PathResolve(
    LPWSTR pszPath,
    WORD** dirs,   // optional
    DWORD fFlags
);
[DllImport("SHELL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int PathResolve(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath,   // LPWSTR in/out
    IntPtr dirs,   // WORD** optional
    uint fFlags   // DWORD
);
<DllImport("SHELL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PathResolve(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder,   ' LPWSTR in/out
    dirs As IntPtr,   ' WORD** optional
    fFlags As UInteger   ' DWORD
) As Integer
End Function
' pszPath : LPWSTR in/out
' dirs : WORD** optional
' fFlags : DWORD
Declare PtrSafe Function PathResolve Lib "shell32" ( _
    ByVal pszPath As LongPtr, _
    ByVal dirs As LongPtr, _
    ByVal fFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathResolve = ctypes.windll.shell32.PathResolve
PathResolve.restype = ctypes.c_int
PathResolve.argtypes = [
    wintypes.LPWSTR,  # pszPath : LPWSTR in/out
    ctypes.c_void_p,  # dirs : WORD** optional
    wintypes.DWORD,  # fFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
PathResolve = Fiddle::Function.new(
  lib['PathResolve'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPWSTR in/out
    Fiddle::TYPE_VOIDP,  # dirs : WORD** optional
    -Fiddle::TYPE_INT,  # fFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn PathResolve(
        pszPath: *mut u16,  // LPWSTR in/out
        dirs: *mut *mut u16,  // WORD** optional
        fFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", SetLastError = true)]
public static extern int PathResolve([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath, IntPtr dirs, uint fFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_PathResolve' -Namespace Win32 -PassThru
# $api::PathResolve(pszPath, dirs, fFlags)
#uselib "SHELL32.dll"
#func global PathResolve "PathResolve" sptr, sptr, sptr
; PathResolve varptr(pszPath), varptr(dirs), fFlags   ; 戻り値は stat
; pszPath : LPWSTR in/out -> "sptr"
; dirs : WORD** optional -> "sptr"
; fFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global PathResolve "PathResolve" var, var, int
; res = PathResolve(pszPath, dirs, fFlags)
; pszPath : LPWSTR in/out -> "var"
; dirs : WORD** optional -> "var"
; fFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT PathResolve(LPWSTR pszPath, WORD** dirs, DWORD fFlags)
#uselib "SHELL32.dll"
#cfunc global PathResolve "PathResolve" var, var, int
; res = PathResolve(pszPath, dirs, fFlags)
; pszPath : LPWSTR in/out -> "var"
; dirs : WORD** optional -> "var"
; fFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procPathResolve = shell32.NewProc("PathResolve")
)

// pszPath (LPWSTR in/out), dirs (WORD** optional), fFlags (DWORD)
r1, _, err := procPathResolve.Call(
	uintptr(pszPath),
	uintptr(dirs),
	uintptr(fFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function PathResolve(
  pszPath: PWideChar;   // LPWSTR in/out
  dirs: Pointer;   // WORD** optional
  fFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'PathResolve';
result := DllCall("SHELL32\PathResolve"
    , "Ptr", pszPath   ; LPWSTR in/out
    , "Ptr", dirs   ; WORD** optional
    , "UInt", fFlags   ; DWORD
    , "Int")   ; return: INT
●PathResolve(pszPath, dirs, fFlags) = DLL("SHELL32.dll", "int PathResolve(char*, void*, dword)")
# 呼び出し: PathResolve(pszPath, dirs, fFlags)
# pszPath : LPWSTR in/out -> "char*"
# dirs : WORD** optional -> "void*"
# fFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn PathResolve(
    pszPath: [*c]u16, // LPWSTR in/out
    dirs: [*c][*c]u16, // WORD** optional
    fFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc PathResolve(
    pszPath: ptr uint16,  # LPWSTR in/out
    dirs: ptr uint16,  # WORD** optional
    fFlags: uint32  # DWORD
): int32 {.importc: "PathResolve", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int PathResolve(
    wchar* pszPath,   // LPWSTR in/out
    ushort** dirs,   // WORD** optional
    uint fFlags   // DWORD
);
ccall((:PathResolve, "SHELL32.dll"), stdcall, Int32,
      (Ptr{UInt16}, Ptr{UInt16}, UInt32),
      pszPath, dirs, fFlags)
# pszPath : LPWSTR in/out -> Ptr{UInt16}
# dirs : WORD** optional -> Ptr{UInt16}
# fFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t PathResolve(
    uint16_t* pszPath,
    uint16_t** dirs,
    uint32_t fFlags);
]]
local shell32 = ffi.load("shell32")
-- shell32.PathResolve(pszPath, dirs, fFlags)
-- pszPath : LPWSTR in/out
-- dirs : WORD** optional
-- fFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const PathResolve = lib.func('__stdcall', 'PathResolve', 'int32_t', ['uint16_t *', 'uint16_t *', 'uint32_t']);
// PathResolve(pszPath, dirs, fFlags)
// pszPath : LPWSTR in/out -> 'uint16_t *'
// dirs : WORD** optional -> 'uint16_t *'
// fFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  PathResolve: { parameters: ["buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.PathResolve(pszPath, dirs, fFlags)
// pszPath : LPWSTR in/out -> "buffer"
// dirs : WORD** optional -> "pointer"
// fFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PathResolve(
    uint16_t* pszPath,
    uint16_t** dirs,
    uint32_t fFlags);
C, "SHELL32.dll");
// $ffi->PathResolve(pszPath, dirs, fFlags);
// pszPath : LPWSTR in/out
// dirs : WORD** optional
// fFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    int PathResolve(
        char[] pszPath,   // LPWSTR in/out
        Pointer dirs,   // WORD** optional
        int fFlags   // DWORD
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun PathResolve = PathResolve(
    pszPath : UInt16*,   # LPWSTR in/out
    dirs : UInt16**,   # WORD** optional
    fFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PathResolveNative = Int32 Function(Pointer<Utf16>, Pointer<Uint16>, Uint32);
typedef PathResolveDart = int Function(Pointer<Utf16>, Pointer<Uint16>, int);
final PathResolve = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<PathResolveNative, PathResolveDart>('PathResolve');
// pszPath : LPWSTR in/out -> Pointer<Utf16>
// dirs : WORD** optional -> Pointer<Uint16>
// fFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathResolve(
  pszPath: PWideChar;   // LPWSTR in/out
  dirs: Pointer;   // WORD** optional
  fFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'PathResolve';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathResolve"
  c_PathResolve :: CWString -> Ptr Word16 -> Word32 -> IO Int32
-- pszPath : LPWSTR in/out -> CWString
-- dirs : WORD** optional -> Ptr Word16
-- fFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathresolve =
  foreign "PathResolve"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pszPath : LPWSTR in/out -> (ptr uint16_t) *)
(* dirs : WORD** optional -> (ptr uint16_t) *)
(* fFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("PathResolve" path-resolve :convention :stdcall) :int32
  (psz-path :pointer)   ; LPWSTR in/out
  (dirs :pointer)   ; WORD** optional
  (f-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathResolve = Win32::API::More->new('SHELL32',
    'int PathResolve(LPWSTR pszPath, LPVOID dirs, DWORD fFlags)');
# my $ret = $PathResolve->Call($pszPath, $dirs, $fFlags);
# pszPath : LPWSTR in/out -> LPWSTR
# dirs : WORD** optional -> LPVOID
# fFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目