PathMatchSpecA
関数ファイル名がワイルドカード指定パターンに一致するか判定する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathMatchSpecA(
LPCSTR pszFile,
LPCSTR pszSpec
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszFile | LPCSTR | in | 検索対象のパスを格納した、null で終わる文字列へのポインター。 |
| pszSpec | LPCSTR | in | 検索対象とするファイルの種類を格納した、null で終わる文字列へのポインター。たとえば pszFile が .doc ファイルかどうかをテストするには、pszSpec に "*.doc" を設定します。 |
戻り値の型: BOOL
公式ドキュメント
Microsoft MS-DOS のワイルドカード一致方式を使用して文字列を検索します。(ANSI)
戻り値
型: BOOL
文字列が一致する場合は TRUE を、それ以外の場合は FALSE を返します。
解説(Remarks)
メモ
shlwapi.h ヘッダーは PathMatchSpec をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版が自動的に選択されます。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PathMatchSpecA(
LPCSTR pszFile,
LPCSTR pszSpec
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathMatchSpecA(
[MarshalAs(UnmanagedType.LPStr)] string pszFile, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string pszSpec // LPCSTR
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathMatchSpecA(
<MarshalAs(UnmanagedType.LPStr)> pszFile As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> pszSpec As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pszFile : LPCSTR
' pszSpec : LPCSTR
Declare PtrSafe Function PathMatchSpecA Lib "shlwapi" ( _
ByVal pszFile As String, _
ByVal pszSpec As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PathMatchSpecA = ctypes.windll.shlwapi.PathMatchSpecA
PathMatchSpecA.restype = wintypes.BOOL
PathMatchSpecA.argtypes = [
wintypes.LPCSTR, # pszFile : LPCSTR
wintypes.LPCSTR, # pszSpec : LPCSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathMatchSpecA = Fiddle::Function.new(
lib['PathMatchSpecA'],
[
Fiddle::TYPE_VOIDP, # pszFile : LPCSTR
Fiddle::TYPE_VOIDP, # pszSpec : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn PathMatchSpecA(
pszFile: *const u8, // LPCSTR
pszSpec: *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)]
public static extern bool PathMatchSpecA([MarshalAs(UnmanagedType.LPStr)] string pszFile, [MarshalAs(UnmanagedType.LPStr)] string pszSpec);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathMatchSpecA' -Namespace Win32 -PassThru
# $api::PathMatchSpecA(pszFile, pszSpec)#uselib "SHLWAPI.dll"
#func global PathMatchSpecA "PathMatchSpecA" sptr, sptr
; PathMatchSpecA pszFile, pszSpec ; 戻り値は stat
; pszFile : LPCSTR -> "sptr"
; pszSpec : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global PathMatchSpecA "PathMatchSpecA" str, str
; res = PathMatchSpecA(pszFile, pszSpec)
; pszFile : LPCSTR -> "str"
; pszSpec : LPCSTR -> "str"; BOOL PathMatchSpecA(LPCSTR pszFile, LPCSTR pszSpec)
#uselib "SHLWAPI.dll"
#cfunc global PathMatchSpecA "PathMatchSpecA" str, str
; res = PathMatchSpecA(pszFile, pszSpec)
; pszFile : LPCSTR -> "str"
; pszSpec : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathMatchSpecA = shlwapi.NewProc("PathMatchSpecA")
)
// pszFile (LPCSTR), pszSpec (LPCSTR)
r1, _, err := procPathMatchSpecA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszFile))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSpec))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction PathMatchSpecA(
pszFile: PAnsiChar; // LPCSTR
pszSpec: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathMatchSpecA';result := DllCall("SHLWAPI\PathMatchSpecA"
, "AStr", pszFile ; LPCSTR
, "AStr", pszSpec ; LPCSTR
, "Int") ; return: BOOL●PathMatchSpecA(pszFile, pszSpec) = DLL("SHLWAPI.dll", "bool PathMatchSpecA(char*, char*)")
# 呼び出し: PathMatchSpecA(pszFile, pszSpec)
# pszFile : LPCSTR -> "char*"
# pszSpec : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn PathMatchSpecA(
pszFile: [*c]const u8, // LPCSTR
pszSpec: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc PathMatchSpecA(
pszFile: cstring, # LPCSTR
pszSpec: cstring # LPCSTR
): int32 {.importc: "PathMatchSpecA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int PathMatchSpecA(
const(char)* pszFile, // LPCSTR
const(char)* pszSpec // LPCSTR
);ccall((:PathMatchSpecA, "SHLWAPI.dll"), stdcall, Int32,
(Cstring, Cstring),
pszFile, pszSpec)
# pszFile : LPCSTR -> Cstring
# pszSpec : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t PathMatchSpecA(
const char* pszFile,
const char* pszSpec);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathMatchSpecA(pszFile, pszSpec)
-- pszFile : LPCSTR
-- pszSpec : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathMatchSpecA = lib.func('__stdcall', 'PathMatchSpecA', 'int32_t', ['str', 'str']);
// PathMatchSpecA(pszFile, pszSpec)
// pszFile : LPCSTR -> 'str'
// pszSpec : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathMatchSpecA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.PathMatchSpecA(pszFile, pszSpec)
// pszFile : LPCSTR -> "buffer"
// pszSpec : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PathMatchSpecA(
const char* pszFile,
const char* pszSpec);
C, "SHLWAPI.dll");
// $ffi->PathMatchSpecA(pszFile, pszSpec);
// pszFile : LPCSTR
// pszSpec : 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 PathMatchSpecA(
String pszFile, // LPCSTR
String pszSpec // LPCSTR
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun PathMatchSpecA = PathMatchSpecA(
pszFile : UInt8*, # LPCSTR
pszSpec : 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 PathMatchSpecANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef PathMatchSpecADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final PathMatchSpecA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathMatchSpecANative, PathMatchSpecADart>('PathMatchSpecA');
// pszFile : LPCSTR -> Pointer<Utf8>
// pszSpec : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathMatchSpecA(
pszFile: PAnsiChar; // LPCSTR
pszSpec: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathMatchSpecA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathMatchSpecA"
c_PathMatchSpecA :: CString -> CString -> IO CInt
-- pszFile : LPCSTR -> CString
-- pszSpec : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathmatchspeca =
foreign "PathMatchSpecA"
(string @-> string @-> returning int32_t)
(* pszFile : LPCSTR -> string *)
(* pszSpec : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("PathMatchSpecA" path-match-spec-a :convention :stdcall) :int32
(psz-file :string) ; LPCSTR
(psz-spec :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathMatchSpecA = Win32::API::More->new('SHLWAPI',
'BOOL PathMatchSpecA(LPCSTR pszFile, LPCSTR pszSpec)');
# my $ret = $PathMatchSpecA->Call($pszFile, $pszSpec);
# pszFile : LPCSTR -> LPCSTR
# pszSpec : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f PathMatchSpecW (Unicode版) — ファイル名がワイルドカード指定パターンに一致するか判定する。
類似 API
- f PathMatchSpecExA — フラグ指定付きでファイル名がパターンに一致するか判定する。