ホーム › System.Diagnostics.Debug › SymMatchFileName

SymMatchFileName

関数

ファイル名がパターンに一致するか比較照合する。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymMatchFileName(
    LPCSTR FileName,
    LPCSTR Match,
    LPSTR* FileNameStop,   // optional
    LPSTR* MatchStop   // optional
);

パラメーター

名前	型	方向	説明
FileName	LPCSTR	in	Match パラメーターと比較されるファイル名です。
Match	LPCSTR	in	FileName パラメーターと比較される文字列です。
FileNameStop	LPSTR*	outoptional	FileName 内で照合が停止した位置へのポインターを受け取る文字列バッファーへのポインターです。完全に一致した場合、この値は FileName の 1 文字前になることがあります。この値は NULL にすることもできます。
MatchStop	LPSTR*	outoptional	Match 内で照合が停止した位置へのポインターを受け取る文字列バッファーへのポインターです。完全に一致した場合、この値は Match の 1 文字前になることがあります。この値は NULL にすることもできます。

戻り値の型: BOOL

公式ドキュメント

SymMatchFileName 関数 (dbghelp.h) は、文字列をファイル名およびパスと比較します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

照合する文字列は完全なファイル名のサフィックスにできるため、この関数を使用して、プレーンなファイル名を完全修飾ファイル名と照合できます。

照合は両方の文字列の末尾から開始され、後方に向かって進みます。照合は大文字と小文字を区別せず、バックスラッシュ (\) とスラッシュ (/) を同一視します。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。したがって、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

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

各言語での呼び出し定義

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymMatchFileName(
    LPCSTR FileName,
    LPCSTR Match,
    LPSTR* FileNameStop,   // optional
    LPSTR* MatchStop   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymMatchFileName(
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string Match,   // LPCSTR
    IntPtr FileNameStop,   // LPSTR* optional, out
    IntPtr MatchStop   // LPSTR* optional, out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymMatchFileName(
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> Match As String,   ' LPCSTR
    FileNameStop As IntPtr,   ' LPSTR* optional, out
    MatchStop As IntPtr   ' LPSTR* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FileName : LPCSTR
' Match : LPCSTR
' FileNameStop : LPSTR* optional, out
' MatchStop : LPSTR* optional, out
Declare PtrSafe Function SymMatchFileName Lib "dbghelp" ( _
    ByVal FileName As String, _
    ByVal Match As String, _
    ByVal FileNameStop As LongPtr, _
    ByVal MatchStop As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymMatchFileName = ctypes.windll.dbghelp.SymMatchFileName
SymMatchFileName.restype = wintypes.BOOL
SymMatchFileName.argtypes = [
    wintypes.LPCSTR,  # FileName : LPCSTR
    wintypes.LPCSTR,  # Match : LPCSTR
    ctypes.c_void_p,  # FileNameStop : LPSTR* optional, out
    ctypes.c_void_p,  # MatchStop : LPSTR* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymMatchFileName = Fiddle::Function.new(
  lib['SymMatchFileName'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # Match : LPCSTR
    Fiddle::TYPE_VOIDP,  # FileNameStop : LPSTR* optional, out
    Fiddle::TYPE_VOIDP,  # MatchStop : LPSTR* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymMatchFileName(
        FileName: *const u8,  // LPCSTR
        Match: *const u8,  // LPCSTR
        FileNameStop: *mut *mut u8,  // LPSTR* optional, out
        MatchStop: *mut *mut u8  // LPSTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SymMatchFileName([MarshalAs(UnmanagedType.LPStr)] string FileName, [MarshalAs(UnmanagedType.LPStr)] string Match, IntPtr FileNameStop, IntPtr MatchStop);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymMatchFileName' -Namespace Win32 -PassThru
# $api::SymMatchFileName(FileName, Match, FileNameStop, MatchStop)

#uselib "dbghelp.dll"
#func global SymMatchFileName "SymMatchFileName" sptr, sptr, sptr, sptr
; SymMatchFileName FileName, Match, varptr(FileNameStop), varptr(MatchStop)   ; 戻り値は stat
; FileName : LPCSTR -> "sptr"
; Match : LPCSTR -> "sptr"
; FileNameStop : LPSTR* optional, out -> "sptr"
; MatchStop : LPSTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymMatchFileName "SymMatchFileName" str, str, var, var
; res = SymMatchFileName(FileName, Match, FileNameStop, MatchStop)
; FileName : LPCSTR -> "str"
; Match : LPCSTR -> "str"
; FileNameStop : LPSTR* optional, out -> "var"
; MatchStop : LPSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global SymMatchFileName "SymMatchFileName" str, str, sptr, sptr
; res = SymMatchFileName(FileName, Match, varptr(FileNameStop), varptr(MatchStop))
; FileName : LPCSTR -> "str"
; Match : LPCSTR -> "str"
; FileNameStop : LPSTR* optional, out -> "sptr"
; MatchStop : LPSTR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。