PathFileExistsA
関数指定したパスのファイルまたはフォルダが存在するか判定する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathFileExistsA(
LPCSTR pszPath
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszPath | LPCSTR | in | 検証対象オブジェクトの完全なパスを格納する、最大長 MAX_PATH の null 終端文字列へのポインター。 |
戻り値の型: BOOL
公式ドキュメント
ファイルやフォルダーなどのファイルシステムオブジェクトへのパスが有効かどうかを判定します。(ANSI)
戻り値
型: BOOL
ファイルが存在する場合は TRUE、それ以外の場合は FALSE。拡張エラー情報を取得するには GetLastError を呼び出してください。
解説(Remarks)
この関数はパスの有効性をテストします。
Universal Naming Convention (UNC) で指定されるパスはファイルのみに限定されます。すなわち、\server\share\file は許可されます。サーバーやサーバー共有への UNC パスは許可されません。すなわち、\server や \server\share は不可です。マウントされたリモートドライブが使用不能な場合、この関数は FALSE を返します。
例
#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 ヘッダーは、PathFileExists を、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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathFileExistsA(
LPCSTR pszPath
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool PathFileExistsA(
[MarshalAs(UnmanagedType.LPStr)] string pszPath // LPCSTR
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PathFileExistsA(
<MarshalAs(UnmanagedType.LPStr)> pszPath As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pszPath : LPCSTR
Declare PtrSafe Function PathFileExistsA Lib "shlwapi" ( _
ByVal pszPath As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PathFileExistsA = ctypes.windll.shlwapi.PathFileExistsA
PathFileExistsA.restype = wintypes.BOOL
PathFileExistsA.argtypes = [
wintypes.LPCSTR, # pszPath : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathFileExistsA = Fiddle::Function.new(
lib['PathFileExistsA'],
[
Fiddle::TYPE_VOIDP, # pszPath : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn PathFileExistsA(
pszPath: *const u8 // LPCSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool PathFileExistsA([MarshalAs(UnmanagedType.LPStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathFileExistsA' -Namespace Win32 -PassThru
# $api::PathFileExistsA(pszPath)#uselib "SHLWAPI.dll"
#func global PathFileExistsA "PathFileExistsA" sptr
; PathFileExistsA pszPath ; 戻り値は stat
; pszPath : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global PathFileExistsA "PathFileExistsA" str
; res = PathFileExistsA(pszPath)
; pszPath : LPCSTR -> "str"; BOOL PathFileExistsA(LPCSTR pszPath)
#uselib "SHLWAPI.dll"
#cfunc global PathFileExistsA "PathFileExistsA" str
; res = PathFileExistsA(pszPath)
; pszPath : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathFileExistsA = shlwapi.NewProc("PathFileExistsA")
)
// pszPath (LPCSTR)
r1, _, err := procPathFileExistsA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction PathFileExistsA(
pszPath: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathFileExistsA';result := DllCall("SHLWAPI\PathFileExistsA"
, "AStr", pszPath ; LPCSTR
, "Int") ; return: BOOL●PathFileExistsA(pszPath) = DLL("SHLWAPI.dll", "bool PathFileExistsA(char*)")
# 呼び出し: PathFileExistsA(pszPath)
# pszPath : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn PathFileExistsA(
pszPath: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc PathFileExistsA(
pszPath: cstring # LPCSTR
): int32 {.importc: "PathFileExistsA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int PathFileExistsA(
const(char)* pszPath // LPCSTR
);ccall((:PathFileExistsA, "SHLWAPI.dll"), stdcall, Int32,
(Cstring,),
pszPath)
# pszPath : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t PathFileExistsA(
const char* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathFileExistsA(pszPath)
-- pszPath : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathFileExistsA = lib.func('__stdcall', 'PathFileExistsA', 'int32_t', ['str']);
// PathFileExistsA(pszPath)
// pszPath : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathFileExistsA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.PathFileExistsA(pszPath)
// pszPath : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PathFileExistsA(
const char* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathFileExistsA(pszPath);
// pszPath : LPCSTR
// 構造体/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.ASCII_OPTIONS);
boolean PathFileExistsA(
String pszPath // LPCSTR
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun PathFileExistsA = PathFileExistsA(
pszPath : UInt8* # LPCSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PathFileExistsANative = Int32 Function(Pointer<Utf8>);
typedef PathFileExistsADart = int Function(Pointer<Utf8>);
final PathFileExistsA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathFileExistsANative, PathFileExistsADart>('PathFileExistsA');
// pszPath : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathFileExistsA(
pszPath: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathFileExistsA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathFileExistsA"
c_PathFileExistsA :: CString -> IO CInt
-- pszPath : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathfileexistsa =
foreign "PathFileExistsA"
(string @-> returning int32_t)
(* pszPath : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("PathFileExistsA" path-file-exists-a :convention :stdcall) :int32
(psz-path :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathFileExistsA = Win32::API::More->new('SHLWAPI',
'BOOL PathFileExistsA(LPCSTR pszPath)');
# my $ret = $PathFileExistsA->Call($pszPath);
# pszPath : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f PathFileExistsW (Unicode版) — 指定したパスのファイルまたはフォルダが存在するか判定する。