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

PathMatchSpecW

関数
ファイル名がワイルドカード指定パターンに一致するか判定する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL PathMatchSpecW(
    LPCWSTR pszFile,
    LPCWSTR pszSpec
);

パラメーター

名前方向説明
pszFileLPCWSTRin検索対象のパスを格納した、null 終端文字列へのポインターです。
pszSpecLPCWSTRin検索するファイルの種類を格納した、null 終端文字列へのポインターです。たとえば、pszFile が .doc ファイルかどうかをテストするには、pszSpec に "*.doc" を設定します。

戻り値の型: BOOL

公式ドキュメント

Microsoft MS-DOS のワイルドカードマッチ形式を使用して文字列を検索します。(Unicode)

戻り値

型: BOOL

文字列が一致する場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PathMatchSpecW(
    LPCWSTR pszFile,
    LPCWSTR pszSpec
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool PathMatchSpecW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszFile,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszSpec   // LPCWSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathMatchSpecW(
    <MarshalAs(UnmanagedType.LPWStr)> pszFile As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszSpec As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszFile : LPCWSTR
' pszSpec : LPCWSTR
Declare PtrSafe Function PathMatchSpecW Lib "shlwapi" ( _
    ByVal pszFile As LongPtr, _
    ByVal pszSpec 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

PathMatchSpecW = ctypes.windll.shlwapi.PathMatchSpecW
PathMatchSpecW.restype = wintypes.BOOL
PathMatchSpecW.argtypes = [
    wintypes.LPCWSTR,  # pszFile : LPCWSTR
    wintypes.LPCWSTR,  # pszSpec : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathMatchSpecW = Fiddle::Function.new(
  lib['PathMatchSpecW'],
  [
    Fiddle::TYPE_VOIDP,  # pszFile : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszSpec : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathMatchSpecW(
        pszFile: *const u16,  // LPCWSTR
        pszSpec: *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)]
public static extern bool PathMatchSpecW([MarshalAs(UnmanagedType.LPWStr)] string pszFile, [MarshalAs(UnmanagedType.LPWStr)] string pszSpec);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathMatchSpecW' -Namespace Win32 -PassThru
# $api::PathMatchSpecW(pszFile, pszSpec)
#uselib "SHLWAPI.dll"
#func global PathMatchSpecW "PathMatchSpecW" wptr, wptr
; PathMatchSpecW pszFile, pszSpec   ; 戻り値は stat
; pszFile : LPCWSTR -> "wptr"
; pszSpec : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global PathMatchSpecW "PathMatchSpecW" wstr, wstr
; res = PathMatchSpecW(pszFile, pszSpec)
; pszFile : LPCWSTR -> "wstr"
; pszSpec : LPCWSTR -> "wstr"
; BOOL PathMatchSpecW(LPCWSTR pszFile, LPCWSTR pszSpec)
#uselib "SHLWAPI.dll"
#cfunc global PathMatchSpecW "PathMatchSpecW" wstr, wstr
; res = PathMatchSpecW(pszFile, pszSpec)
; pszFile : LPCWSTR -> "wstr"
; pszSpec : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathMatchSpecW = shlwapi.NewProc("PathMatchSpecW")
)

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

extern "shlwapi" fn PathMatchSpecW(
    pszFile: [*c]const u16, // LPCWSTR
    pszSpec: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PathMatchSpecW(
    pszFile: WideCString,  # LPCWSTR
    pszSpec: WideCString  # LPCWSTR
): int32 {.importc: "PathMatchSpecW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int PathMatchSpecW(
    const(wchar)* pszFile,   // LPCWSTR
    const(wchar)* pszSpec   // LPCWSTR
);
ccall((:PathMatchSpecW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Cwstring),
      pszFile, pszSpec)
# pszFile : LPCWSTR -> Cwstring
# pszSpec : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t PathMatchSpecW(
    const uint16_t* pszFile,
    const uint16_t* pszSpec);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathMatchSpecW(pszFile, pszSpec)
-- pszFile : LPCWSTR
-- pszSpec : 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 PathMatchSpecW = lib.func('__stdcall', 'PathMatchSpecW', 'int32_t', ['str16', 'str16']);
// PathMatchSpecW(pszFile, pszSpec)
// pszFile : LPCWSTR -> 'str16'
// pszSpec : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathMatchSpecW: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.PathMatchSpecW(pszFile, pszSpec)
// pszFile : LPCWSTR -> "buffer"
// pszSpec : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PathMatchSpecW(
    const uint16_t* pszFile,
    const uint16_t* pszSpec);
C, "SHLWAPI.dll");
// $ffi->PathMatchSpecW(pszFile, pszSpec);
// pszFile : LPCWSTR
// pszSpec : 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 PathMatchSpecW(
        WString pszFile,   // LPCWSTR
        WString pszSpec   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathMatchSpecW = PathMatchSpecW(
    pszFile : UInt16*,   # LPCWSTR
    pszSpec : 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 PathMatchSpecWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef PathMatchSpecWDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final PathMatchSpecW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathMatchSpecWNative, PathMatchSpecWDart>('PathMatchSpecW');
// pszFile : LPCWSTR -> Pointer<Utf16>
// pszSpec : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathMatchSpecW(
  pszFile: PWideChar;   // LPCWSTR
  pszSpec: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathMatchSpecW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let pathmatchspecw =
  foreign "PathMatchSpecW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* pszFile : LPCWSTR -> (ptr uint16_t) *)
(* pszSpec : 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 ("PathMatchSpecW" path-match-spec-w :convention :stdcall) :int32
  (psz-file (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-spec (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathMatchSpecW = Win32::API::More->new('SHLWAPI',
    'BOOL PathMatchSpecW(LPCWSTR pszFile, LPCWSTR pszSpec)');
# my $ret = $PathMatchSpecW->Call($pszFile, $pszSpec);
# pszFile : LPCWSTR -> LPCWSTR
# pszSpec : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API