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

SymSrvIsStore

関数
指定パスがシンボルストアかどうか判定する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymSrvIsStore(
    HANDLE hProcess,   // optional
    LPCSTR path
);

パラメーター

名前方向説明
hProcessHANDLEinoptional以前に SymInitialize 関数に渡したプロセスのハンドル。このパラメーターが NULL に設定されている場合、関数はストアが存在するかどうかのみを判定します。それ以外の場合、関数はストアが存在し、かつ指定されたプロセスハンドルのプロセスエントリを含んでいるかどうかを判定します。
pathLPCSTRinシンボルストアへのパス。このパスには、既定のシンボルストア (例: SRV*)、HTTP または HTTPS シンボルサーバーへの指定、あるいはストアへの UNC、絶対、または相対パスを指定できます。

戻り値の型: BOOL

公式ドキュメント

SymSrvIsStore 関数 (dbghelp.h) は、指定されたパスがシンボルストアを指しているかどうかを判定します。

戻り値

パスがシンボルストアを指定している場合、関数は TRUE を返します。それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

解説(Remarks)

パスが既定のシンボルストア (例: SRV*) または HTTP もしくは HTTPS シンボルサーバーを指している場合、関数はストアが存在すると見なします。

クライアントコンピューターとサーバーの間にプロキシコンピューターがある場合、プロキシ上の SymSrv.dll のバージョンは、クライアント上のバージョンより古いものであってはなりません。

この関数を含むすべての 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 SymSrvIsStore(
    HANDLE hProcess,   // optional
    LPCSTR path
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymSrvIsStore(
    IntPtr hProcess,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPStr)] string path   // LPCSTR
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSrvIsStore(
    hProcess As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPStr)> path As String   ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE optional
' path : LPCSTR
Declare PtrSafe Function SymSrvIsStore Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal path As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymSrvIsStore = ctypes.windll.dbghelp.SymSrvIsStore
SymSrvIsStore.restype = wintypes.BOOL
SymSrvIsStore.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE optional
    wintypes.LPCSTR,  # path : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymSrvIsStore = Fiddle::Function.new(
  lib['SymSrvIsStore'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE optional
    Fiddle::TYPE_VOIDP,  # path : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymSrvIsStore(
        hProcess: *mut core::ffi::c_void,  // HANDLE optional
        path: *const u8  // LPCSTR
    ) -> 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 SymSrvIsStore(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string path);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSrvIsStore' -Namespace Win32 -PassThru
# $api::SymSrvIsStore(hProcess, path)
#uselib "dbghelp.dll"
#func global SymSrvIsStore "SymSrvIsStore" sptr, sptr
; SymSrvIsStore hProcess, path   ; 戻り値は stat
; hProcess : HANDLE optional -> "sptr"
; path : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymSrvIsStore "SymSrvIsStore" sptr, str
; res = SymSrvIsStore(hProcess, path)
; hProcess : HANDLE optional -> "sptr"
; path : LPCSTR -> "str"
; BOOL SymSrvIsStore(HANDLE hProcess, LPCSTR path)
#uselib "dbghelp.dll"
#cfunc global SymSrvIsStore "SymSrvIsStore" intptr, str
; res = SymSrvIsStore(hProcess, path)
; hProcess : HANDLE optional -> "intptr"
; path : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSrvIsStore = dbghelp.NewProc("SymSrvIsStore")
)

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

extern "dbghelp" fn SymSrvIsStore(
    hProcess: ?*anyopaque, // HANDLE optional
    path: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc SymSrvIsStore(
    hProcess: pointer,  # HANDLE optional
    path: cstring  # LPCSTR
): int32 {.importc: "SymSrvIsStore", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymSrvIsStore(
    void* hProcess,   // HANDLE optional
    const(char)* path   // LPCSTR
);
ccall((:SymSrvIsStore, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring),
      hProcess, path)
# hProcess : HANDLE optional -> Ptr{Cvoid}
# path : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymSrvIsStore(
    void* hProcess,
    const char* path);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymSrvIsStore(hProcess, path)
-- hProcess : HANDLE optional
-- path : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymSrvIsStore = lib.func('__stdcall', 'SymSrvIsStore', 'int32_t', ['void *', 'str']);
// SymSrvIsStore(hProcess, path)
// hProcess : HANDLE optional -> 'void *'
// path : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymSrvIsStore: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.SymSrvIsStore(hProcess, path)
// hProcess : HANDLE optional -> "pointer"
// path : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymSrvIsStore(
    void* hProcess,
    const char* path);
C, "dbghelp.dll");
// $ffi->SymSrvIsStore(hProcess, path);
// hProcess : HANDLE optional
// path : 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 Dbghelp extends StdCallLibrary {
    Dbghelp INSTANCE = Native.load("dbghelp", Dbghelp.class, W32APIOptions.ASCII_OPTIONS);
    boolean SymSrvIsStore(
        Pointer hProcess,   // HANDLE optional
        String path   // LPCSTR
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymSrvIsStore = SymSrvIsStore(
    hProcess : Void*,   # HANDLE optional
    path : 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 SymSrvIsStoreNative = Int32 Function(Pointer<Void>, Pointer<Utf8>);
typedef SymSrvIsStoreDart = int Function(Pointer<Void>, Pointer<Utf8>);
final SymSrvIsStore = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymSrvIsStoreNative, SymSrvIsStoreDart>('SymSrvIsStore');
// hProcess : HANDLE optional -> Pointer<Void>
// path : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymSrvIsStore(
  hProcess: THandle;   // HANDLE optional
  path: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymSrvIsStore';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymSrvIsStore"
  c_SymSrvIsStore :: Ptr () -> CString -> IO CInt
-- hProcess : HANDLE optional -> Ptr ()
-- path : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symsrvisstore =
  foreign "SymSrvIsStore"
    ((ptr void) @-> string @-> returning int32_t)
(* hProcess : HANDLE optional -> (ptr void) *)
(* path : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymSrvIsStore" sym-srv-is-store :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE optional
  (path :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSrvIsStore = Win32::API::More->new('dbghelp',
    'BOOL SymSrvIsStore(HANDLE hProcess, LPCSTR path)');
# my $ret = $SymSrvIsStore->Call($hProcess, $path);
# hProcess : HANDLE optional -> HANDLE
# path : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い