PathMatchSpecExA
関数フラグ指定付きでファイル名がパターンに一致するか判定する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
HRESULT PathMatchSpecExA(
LPCSTR pszFile,
LPCSTR pszSpec,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszFile | LPCSTR | in | 照合対象となるファイル名を含むパスを格納した、null 終端文字列へのポインターです。 |
| pszSpec | LPCSTR | in | 検索対象とするファイル名パターンを格納した、null 終端文字列へのポインターです。正確なファイル名を指定することも、ワイルドカード文字を含めることもできます。パターンを 1 つだけ指定する場合は、dwFlags に PMSF_NORMAL フラグを設定します。複数のパターンを指定する場合は、それらをセミコロンで区切り、PMSF_MULTIPLE フラグを設定します。 |
| dwFlags | DWORD | in | 検索条件を変更します。次のフラグが有効です。 PMSF_NORMAL (0x00000000)pszSpec パラメーターは、照合対象となる単一のファイル名パターンを指します。 PMSF_MULTIPLE (0x00000001)pszSpec パラメーターは、照合対象となるセミコロン区切りのファイル名パターンのリストを指します。 PMSF_DONT_STRIP_SPACES (0x00010000)PMSF_NORMAL を使用する場合、pszSpec が指す文字列の先頭の空白を無視しません。PMSF_MULTIPLE を使用する場合、pszSpec が指す文字列に含まれる各ファイル種別の先頭の空白を無視しません。このフラグは PMSF_NORMAL および PMSF_MULTIPLE と組み合わせることができます。 |
戻り値の型: HRESULT
公式ドキュメント
パス内のファイル名を、1 つ以上のファイル名パターンと照合します。(ANSI)
戻り値
型: HRESULT
次のいずれかの値を返します。
| 戻り値 | 説明 |
|---|---|
| pszSpec で指定されたファイル名パターンが、pszFile が指す文字列内のファイル名に一致しました。 | |
| pszSpec で指定されたファイル名パターンのいずれも、pszFile が指す文字列内のファイル名に一致しませんでした。 |
解説(Remarks)
メモ
shlwapi.h ヘッダーは PathMatchSpecEx をエイリアスとして定義しており、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>
HRESULT PathMatchSpecExA(
LPCSTR pszFile,
LPCSTR pszSpec,
DWORD dwFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int PathMatchSpecExA(
[MarshalAs(UnmanagedType.LPStr)] string pszFile, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string pszSpec, // LPCSTR
uint dwFlags // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathMatchSpecExA(
<MarshalAs(UnmanagedType.LPStr)> pszFile As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> pszSpec As String, ' LPCSTR
dwFlags As UInteger ' DWORD
) As Integer
End Function' pszFile : LPCSTR
' pszSpec : LPCSTR
' dwFlags : DWORD
Declare PtrSafe Function PathMatchSpecExA Lib "shlwapi" ( _
ByVal pszFile As String, _
ByVal pszSpec As String, _
ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PathMatchSpecExA = ctypes.windll.shlwapi.PathMatchSpecExA
PathMatchSpecExA.restype = ctypes.c_int
PathMatchSpecExA.argtypes = [
wintypes.LPCSTR, # pszFile : LPCSTR
wintypes.LPCSTR, # pszSpec : LPCSTR
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathMatchSpecExA = Fiddle::Function.new(
lib['PathMatchSpecExA'],
[
Fiddle::TYPE_VOIDP, # pszFile : LPCSTR
Fiddle::TYPE_VOIDP, # pszSpec : LPCSTR
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn PathMatchSpecExA(
pszFile: *const u8, // LPCSTR
pszSpec: *const u8, // LPCSTR
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int PathMatchSpecExA([MarshalAs(UnmanagedType.LPStr)] string pszFile, [MarshalAs(UnmanagedType.LPStr)] string pszSpec, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathMatchSpecExA' -Namespace Win32 -PassThru
# $api::PathMatchSpecExA(pszFile, pszSpec, dwFlags)#uselib "SHLWAPI.dll"
#func global PathMatchSpecExA "PathMatchSpecExA" sptr, sptr, sptr
; PathMatchSpecExA pszFile, pszSpec, dwFlags ; 戻り値は stat
; pszFile : LPCSTR -> "sptr"
; pszSpec : LPCSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global PathMatchSpecExA "PathMatchSpecExA" str, str, int
; res = PathMatchSpecExA(pszFile, pszSpec, dwFlags)
; pszFile : LPCSTR -> "str"
; pszSpec : LPCSTR -> "str"
; dwFlags : DWORD -> "int"; HRESULT PathMatchSpecExA(LPCSTR pszFile, LPCSTR pszSpec, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global PathMatchSpecExA "PathMatchSpecExA" str, str, int
; res = PathMatchSpecExA(pszFile, pszSpec, dwFlags)
; pszFile : LPCSTR -> "str"
; pszSpec : LPCSTR -> "str"
; dwFlags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathMatchSpecExA = shlwapi.NewProc("PathMatchSpecExA")
)
// pszFile (LPCSTR), pszSpec (LPCSTR), dwFlags (DWORD)
r1, _, err := procPathMatchSpecExA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszFile))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSpec))),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction PathMatchSpecExA(
pszFile: PAnsiChar; // LPCSTR
pszSpec: PAnsiChar; // LPCSTR
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'PathMatchSpecExA';result := DllCall("SHLWAPI\PathMatchSpecExA"
, "AStr", pszFile ; LPCSTR
, "AStr", pszSpec ; LPCSTR
, "UInt", dwFlags ; DWORD
, "Int") ; return: HRESULT●PathMatchSpecExA(pszFile, pszSpec, dwFlags) = DLL("SHLWAPI.dll", "int PathMatchSpecExA(char*, char*, dword)")
# 呼び出し: PathMatchSpecExA(pszFile, pszSpec, dwFlags)
# pszFile : LPCSTR -> "char*"
# pszSpec : LPCSTR -> "char*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn PathMatchSpecExA(
pszFile: [*c]const u8, // LPCSTR
pszSpec: [*c]const u8, // LPCSTR
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc PathMatchSpecExA(
pszFile: cstring, # LPCSTR
pszSpec: cstring, # LPCSTR
dwFlags: uint32 # DWORD
): int32 {.importc: "PathMatchSpecExA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int PathMatchSpecExA(
const(char)* pszFile, // LPCSTR
const(char)* pszSpec, // LPCSTR
uint dwFlags // DWORD
);ccall((:PathMatchSpecExA, "SHLWAPI.dll"), stdcall, Int32,
(Cstring, Cstring, UInt32),
pszFile, pszSpec, dwFlags)
# pszFile : LPCSTR -> Cstring
# pszSpec : LPCSTR -> Cstring
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t PathMatchSpecExA(
const char* pszFile,
const char* pszSpec,
uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathMatchSpecExA(pszFile, pszSpec, dwFlags)
-- pszFile : LPCSTR
-- pszSpec : LPCSTR
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathMatchSpecExA = lib.func('__stdcall', 'PathMatchSpecExA', 'int32_t', ['str', 'str', 'uint32_t']);
// PathMatchSpecExA(pszFile, pszSpec, dwFlags)
// pszFile : LPCSTR -> 'str'
// pszSpec : LPCSTR -> 'str'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathMatchSpecExA: { parameters: ["buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.PathMatchSpecExA(pszFile, pszSpec, dwFlags)
// pszFile : LPCSTR -> "buffer"
// pszSpec : LPCSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PathMatchSpecExA(
const char* pszFile,
const char* pszSpec,
uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->PathMatchSpecExA(pszFile, pszSpec, dwFlags);
// pszFile : LPCSTR
// pszSpec : LPCSTR
// dwFlags : 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 Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
int PathMatchSpecExA(
String pszFile, // LPCSTR
String pszSpec, // LPCSTR
int dwFlags // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun PathMatchSpecExA = PathMatchSpecExA(
pszFile : UInt8*, # LPCSTR
pszSpec : UInt8*, # LPCSTR
dwFlags : 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 PathMatchSpecExANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef PathMatchSpecExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final PathMatchSpecExA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathMatchSpecExANative, PathMatchSpecExADart>('PathMatchSpecExA');
// pszFile : LPCSTR -> Pointer<Utf8>
// pszSpec : LPCSTR -> Pointer<Utf8>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathMatchSpecExA(
pszFile: PAnsiChar; // LPCSTR
pszSpec: PAnsiChar; // LPCSTR
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'PathMatchSpecExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathMatchSpecExA"
c_PathMatchSpecExA :: CString -> CString -> Word32 -> IO Int32
-- pszFile : LPCSTR -> CString
-- pszSpec : LPCSTR -> CString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathmatchspecexa =
foreign "PathMatchSpecExA"
(string @-> string @-> uint32_t @-> returning int32_t)
(* pszFile : LPCSTR -> string *)
(* pszSpec : LPCSTR -> string *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("PathMatchSpecExA" path-match-spec-ex-a :convention :stdcall) :int32
(psz-file :string) ; LPCSTR
(psz-spec :string) ; LPCSTR
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathMatchSpecExA = Win32::API::More->new('SHLWAPI',
'int PathMatchSpecExA(LPCSTR pszFile, LPCSTR pszSpec, DWORD dwFlags)');
# my $ret = $PathMatchSpecExA->Call($pszFile, $pszSpec, $dwFlags);
# pszFile : LPCSTR -> LPCSTR
# pszSpec : LPCSTR -> LPCSTR
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f PathMatchSpecExW (Unicode版) — フラグ指定付きでファイル名がパターンに一致するか判定する。
類似 API
- f PathMatchSpecA — ファイル名がワイルドカード指定パターンに一致するか判定する。