Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › SymMatchStringA

SymMatchStringA

関数
文字列がワイルドカード式に一致するか判定する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

BOOL SymMatchStringA(
    LPCSTR string,
    LPCSTR expression,
    BOOL fCase
);

パラメーター

名前方向説明
stringLPCSTRinexpression パラメーターと比較する、シンボル名などの文字列。
expressionLPCSTRinstring パラメーターと比較するワイルドカード式。ワイルドカード式では * および ? 文字を使用できます。* は任意の文字列に一致し、? は任意の 1 文字に一致します。
fCaseBOOLin比較で大文字と小文字を区別するかどうかを示す変数。

戻り値の型: BOOL

公式ドキュメント

指定された文字列を、指定されたワイルドカード式と比較します。(SymMatchStringA)

戻り値

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

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

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SymMatchStringA(
    LPCSTR string,
    LPCSTR expression,
    BOOL fCase
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SymMatchStringA(
    [MarshalAs(UnmanagedType.LPStr)] string string,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string expression,   // LPCSTR
    bool fCase   // BOOL
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SymMatchStringA(
    <MarshalAs(UnmanagedType.LPStr)> [string] As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> expression As String,   ' LPCSTR
    fCase As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' string : LPCSTR
' expression : LPCSTR
' fCase : BOOL
Declare PtrSafe Function SymMatchStringA Lib "dbghelp" ( _
    ByVal string As String, _
    ByVal expression As String, _
    ByVal fCase As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymMatchStringA = ctypes.windll.dbghelp.SymMatchStringA
SymMatchStringA.restype = wintypes.BOOL
SymMatchStringA.argtypes = [
    wintypes.LPCSTR,  # string : LPCSTR
    wintypes.LPCSTR,  # expression : LPCSTR
    wintypes.BOOL,  # fCase : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymMatchStringA = Fiddle::Function.new(
  lib['SymMatchStringA'],
  [
    Fiddle::TYPE_VOIDP,  # string : LPCSTR
    Fiddle::TYPE_VOIDP,  # expression : LPCSTR
    Fiddle::TYPE_INT,  # fCase : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymMatchStringA(
        string: *const u8,  // LPCSTR
        expression: *const u8,  // LPCSTR
        fCase: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi)]
public static extern bool SymMatchStringA([MarshalAs(UnmanagedType.LPStr)] string string, [MarshalAs(UnmanagedType.LPStr)] string expression, bool fCase);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymMatchStringA' -Namespace Win32 -PassThru
# $api::SymMatchStringA(string, expression, fCase)
#uselib "dbghelp.dll"
#func global SymMatchStringA "SymMatchStringA" sptr, sptr, sptr
; SymMatchStringA string, expression, fCase   ; 戻り値は stat
; string : LPCSTR -> "sptr"
; expression : LPCSTR -> "sptr"
; fCase : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymMatchStringA "SymMatchStringA" str, str, int
; res = SymMatchStringA(string, expression, fCase)
; string : LPCSTR -> "str"
; expression : LPCSTR -> "str"
; fCase : BOOL -> "int"
; BOOL SymMatchStringA(LPCSTR string, LPCSTR expression, BOOL fCase)
#uselib "dbghelp.dll"
#cfunc global SymMatchStringA "SymMatchStringA" str, str, int
; res = SymMatchStringA(string, expression, fCase)
; string : LPCSTR -> "str"
; expression : LPCSTR -> "str"
; fCase : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymMatchStringA = dbghelp.NewProc("SymMatchStringA")
)

// string (LPCSTR), expression (LPCSTR), fCase (BOOL)
r1, _, err := procSymMatchStringA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(string))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(expression))),
	uintptr(fCase),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymMatchStringA(
  string: PAnsiChar;   // LPCSTR
  expression: PAnsiChar;   // LPCSTR
  fCase: BOOL   // BOOL
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymMatchStringA';
result := DllCall("dbghelp\SymMatchStringA"
    , "AStr", string   ; LPCSTR
    , "AStr", expression   ; LPCSTR
    , "Int", fCase   ; BOOL
    , "Int")   ; return: BOOL
●SymMatchStringA(string, expression, fCase) = DLL("dbghelp.dll", "bool SymMatchStringA(char*, char*, bool)")
# 呼び出し: SymMatchStringA(string, expression, fCase)
# string : LPCSTR -> "char*"
# expression : LPCSTR -> "char*"
# fCase : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dbghelp" fn SymMatchStringA(
    string: [*c]const u8, // LPCSTR
    expression: [*c]const u8, // LPCSTR
    fCase: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc SymMatchStringA(
    string: cstring,  # LPCSTR
    expression: cstring,  # LPCSTR
    fCase: int32  # BOOL
): int32 {.importc: "SymMatchStringA", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymMatchStringA(
    const(char)* string,   // LPCSTR
    const(char)* expression,   // LPCSTR
    int fCase   // BOOL
);
ccall((:SymMatchStringA, "dbghelp.dll"), stdcall, Int32,
      (Cstring, Cstring, Int32),
      string, expression, fCase)
# string : LPCSTR -> Cstring
# expression : LPCSTR -> Cstring
# fCase : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymMatchStringA(
    const char* string,
    const char* expression,
    int32_t fCase);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymMatchStringA(string, expression, fCase)
-- string : LPCSTR
-- expression : LPCSTR
-- fCase : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymMatchStringA = lib.func('__stdcall', 'SymMatchStringA', 'int32_t', ['str', 'str', 'int32_t']);
// SymMatchStringA(string, expression, fCase)
// string : LPCSTR -> 'str'
// expression : LPCSTR -> 'str'
// fCase : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymMatchStringA: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.SymMatchStringA(string, expression, fCase)
// string : LPCSTR -> "buffer"
// expression : LPCSTR -> "buffer"
// fCase : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymMatchStringA(
    const char* string,
    const char* expression,
    int32_t fCase);
C, "dbghelp.dll");
// $ffi->SymMatchStringA(string, expression, fCase);
// string : LPCSTR
// expression : LPCSTR
// fCase : BOOL
// 構造体/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 Dbghelp extends StdCallLibrary {
    Dbghelp INSTANCE = Native.load("dbghelp", Dbghelp.class, W32APIOptions.ASCII_OPTIONS);
    boolean SymMatchStringA(
        String string,   // LPCSTR
        String expression,   // LPCSTR
        boolean fCase   // BOOL
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymMatchStringA = SymMatchStringA(
    string : UInt8*,   # LPCSTR
    expression : UInt8*,   # LPCSTR
    fCase : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymMatchStringANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32);
typedef SymMatchStringADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final SymMatchStringA = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymMatchStringANative, SymMatchStringADart>('SymMatchStringA');
// string : LPCSTR -> Pointer<Utf8>
// expression : LPCSTR -> Pointer<Utf8>
// fCase : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymMatchStringA(
  string: PAnsiChar;   // LPCSTR
  expression: PAnsiChar;   // LPCSTR
  fCase: BOOL   // BOOL
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymMatchStringA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymMatchStringA"
  c_SymMatchStringA :: CString -> CString -> CInt -> IO CInt
-- string : LPCSTR -> CString
-- expression : LPCSTR -> CString
-- fCase : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symmatchstringa =
  foreign "SymMatchStringA"
    (string @-> string @-> int32_t @-> returning int32_t)
(* string : LPCSTR -> string *)
(* expression : LPCSTR -> string *)
(* fCase : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymMatchStringA" sym-match-string-a :convention :stdcall) :int32
  (string :string)   ; LPCSTR
  (expression :string)   ; LPCSTR
  (f-case :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymMatchStringA = Win32::API::More->new('dbghelp',
    'BOOL SymMatchStringA(LPCSTR string, LPCSTR expression, BOOL fCase)');
# my $ret = $SymMatchStringA->Call($string, $expression, $fCase);
# string : LPCSTR -> LPCSTR
# expression : LPCSTR -> LPCSTR
# fCase : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い