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

PathFileExistsW

関数
指定したパスのファイルまたはフォルダが存在するか判定する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL PathFileExistsW(
    LPCWSTR pszPath
);

パラメーター

名前方向説明
pszPathLPCWSTRin検証対象オブジェクトのフルパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインター。

戻り値の型: BOOL

公式ドキュメント

ファイルやフォルダーなどのファイルシステムオブジェクトへのパスが有効かどうかを判定します。(Unicode)

戻り値

型: BOOL

ファイルが存在する場合は TRUE、それ以外の場合は FALSE。拡張エラー情報を取得するには GetLastError を呼び出してください。ファイルが存在しない場合、GetLastErrorERROR_FILE_NOT_FOUND を返します。

解説(Remarks)

この関数はパスの有効性をテストします。

Universal Naming Convention (UNC) で指定するパスはファイルのみに限定されます。すなわち \server\share\file は許可されます。サーバーやサーバー共有を指す UNC パスは許可されません。すなわち \server や \server\share は使用できません。マウントされたリモートドライブが利用不可の場合、この関数は FALSE を返します。

Examples


#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

void main(void)
{
    // Valid file path name (file is there).
    char buffer_1[ ] = "C:\\TEST\\file.txt"; 
    char *lpStr1;
    lpStr1 = buffer_1;
    
    // Invalid file path name (file is not there).
    char buffer_2[ ] = "C:\\TEST\\file.doc"; 
    char *lpStr2;
    lpStr2 = buffer_2;
    
    // Return value from "PathFileExists".
    int retval;
    
    // Search for the presence of a file with a true result.
    retval = PathFileExists(lpStr1);
    if(retval == 1)
    {
        cout << "Search for the file path of : " << lpStr1 << endl;
        cout << "The file requested \"" << lpStr1 << "\" is a valid file" << endl;
        cout << "The return from function is : " << retval << endl;
    }
    
    else
    {
        cout << "\nThe file requested " << lpStr1 << " is not a valid file" << endl;
        cout << "The return from function is : " << retval << endl;
    }
    
    // Search for the presence of a file with a false result.
    retval = PathFileExists(lpStr2);
    
    if(retval == 1)
    {
        cout << "\nThe file requested " << lpStr2 << "is a valid file" << endl;
        cout << "Search for the file path of : " << lpStr2 << endl;
        cout << "The return from function is : " << retval << endl;
    }
    else
    {
        cout << "\nThe file requested \"" << lpStr2 << "\" is not a valid file" << endl;
        cout << "The return from function is : " << retval << endl;
    }
}

OUTPUT
==============
Search for the file path of : C:\TEST\file.txt
The file requested "C:\TEST\file.txt" is a valid file
The return from function is : 1

The file requested "C:\TEST\file.doc" is not a valid file
The return from function is : 0
メモ

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

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

各言語での呼び出し定義

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

BOOL PathFileExistsW(
    LPCWSTR pszPath
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool PathFileExistsW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath   // LPCWSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PathFileExistsW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszPath : LPCWSTR
Declare PtrSafe Function PathFileExistsW Lib "shlwapi" ( _
    ByVal pszPath 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

PathFileExistsW = ctypes.windll.shlwapi.PathFileExistsW
PathFileExistsW.restype = wintypes.BOOL
PathFileExistsW.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathFileExistsW = Fiddle::Function.new(
  lib['PathFileExistsW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathFileExistsW(
        pszPath: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool PathFileExistsW([MarshalAs(UnmanagedType.LPWStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathFileExistsW' -Namespace Win32 -PassThru
# $api::PathFileExistsW(pszPath)
#uselib "SHLWAPI.dll"
#func global PathFileExistsW "PathFileExistsW" wptr
; PathFileExistsW pszPath   ; 戻り値は stat
; pszPath : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global PathFileExistsW "PathFileExistsW" wstr
; res = PathFileExistsW(pszPath)
; pszPath : LPCWSTR -> "wstr"
; BOOL PathFileExistsW(LPCWSTR pszPath)
#uselib "SHLWAPI.dll"
#cfunc global PathFileExistsW "PathFileExistsW" wstr
; res = PathFileExistsW(pszPath)
; pszPath : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathFileExistsW = shlwapi.NewProc("PathFileExistsW")
)

// pszPath (LPCWSTR)
r1, _, err := procPathFileExistsW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PathFileExistsW(
  pszPath: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathFileExistsW';
result := DllCall("SHLWAPI\PathFileExistsW"
    , "WStr", pszPath   ; LPCWSTR
    , "Int")   ; return: BOOL
●PathFileExistsW(pszPath) = DLL("SHLWAPI.dll", "bool PathFileExistsW(char*)")
# 呼び出し: PathFileExistsW(pszPath)
# pszPath : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn PathFileExistsW(
    pszPath: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PathFileExistsW(
    pszPath: WideCString  # LPCWSTR
): int32 {.importc: "PathFileExistsW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int PathFileExistsW(
    const(wchar)* pszPath   // LPCWSTR
);
ccall((:PathFileExistsW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring,),
      pszPath)
# pszPath : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t PathFileExistsW(
    const uint16_t* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathFileExistsW(pszPath)
-- pszPath : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathFileExistsW = lib.func('__stdcall', 'PathFileExistsW', 'int32_t', ['str16']);
// PathFileExistsW(pszPath)
// pszPath : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathFileExistsW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.PathFileExistsW(pszPath)
// pszPath : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PathFileExistsW(
    const uint16_t* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathFileExistsW(pszPath);
// pszPath : LPCWSTR
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean PathFileExistsW(
        WString pszPath   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathFileExistsW = PathFileExistsW(
    pszPath : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PathFileExistsWNative = Int32 Function(Pointer<Utf16>);
typedef PathFileExistsWDart = int Function(Pointer<Utf16>);
final PathFileExistsW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathFileExistsWNative, PathFileExistsWDart>('PathFileExistsW');
// pszPath : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathFileExistsW(
  pszPath: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathFileExistsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathFileExistsW"
  c_PathFileExistsW :: CWString -> IO CInt
-- pszPath : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathfileexistsw =
  foreign "PathFileExistsW"
    ((ptr uint16_t) @-> returning int32_t)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathFileExistsW" path-file-exists-w :convention :stdcall) :int32
  (psz-path (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathFileExistsW = Win32::API::More->new('SHLWAPI',
    'BOOL PathFileExistsW(LPCWSTR pszPath)');
# my $ret = $PathFileExistsW->Call($pszPath);
# pszPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い