ホーム › System.Diagnostics.Debug › SymSetSearchPath
SymSetSearchPath
関数シンボル検索パスを設定する。
シグネチャ
// dbghelp.dll (ANSI / -A)
#include <windows.h>
BOOL SymSetSearchPath(
HANDLE hProcess,
LPCSTR SearchPathA // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hProcess | HANDLE | in | 元々 SymInitialize 関数に渡されたプロセスへのハンドル。 |
| SearchPathA | LPCSTR | inoptional | 新たに設定するシンボル検索パスの文字列。複数はセミコロン区切り。NULL可で既定へ。 |
戻り値の型: BOOL
公式ドキュメント
SymSetSearchPath 関数 (dbghelp.h) は、指定したプロセスの検索パスを設定します。
戻り値
関数が成功した場合、戻り値は TRUE です。
関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
シンボル検索パスは、ライブラリがアプリケーションによって使用されている間、何度でも変更できます。変更は、シンボルハンドラーへの以降のすべての呼び出しに影響します。
現在の検索パスを取得するには、 SymGetSearchPath 関数を呼び出します。
この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。
この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// dbghelp.dll (ANSI / -A)
#include <windows.h>
BOOL SymSetSearchPath(
HANDLE hProcess,
LPCSTR SearchPathA // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymSetSearchPath(
IntPtr hProcess, // HANDLE
[MarshalAs(UnmanagedType.LPStr)] string SearchPathA // LPCSTR optional
);<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSetSearchPath(
hProcess As IntPtr, ' HANDLE
<MarshalAs(UnmanagedType.LPStr)> SearchPathA As String ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hProcess : HANDLE
' SearchPathA : LPCSTR optional
Declare PtrSafe Function SymSetSearchPath Lib "dbghelp" ( _
ByVal hProcess As LongPtr, _
ByVal SearchPathA As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SymSetSearchPath = ctypes.windll.dbghelp.SymSetSearchPath
SymSetSearchPath.restype = wintypes.BOOL
SymSetSearchPath.argtypes = [
wintypes.HANDLE, # hProcess : HANDLE
wintypes.LPCSTR, # SearchPathA : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('dbghelp.dll')
SymSetSearchPath = Fiddle::Function.new(
lib['SymSetSearchPath'],
[
Fiddle::TYPE_VOIDP, # hProcess : HANDLE
Fiddle::TYPE_VOIDP, # SearchPathA : LPCSTR optional
],
Fiddle::TYPE_INT)#[link(name = "dbghelp")]
extern "system" {
fn SymSetSearchPath(
hProcess: *mut core::ffi::c_void, // HANDLE
SearchPathA: *const u8 // LPCSTR optional
) -> 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 SymSetSearchPath(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string SearchPathA);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSetSearchPath' -Namespace Win32 -PassThru
# $api::SymSetSearchPath(hProcess, SearchPathA)#uselib "dbghelp.dll"
#func global SymSetSearchPath "SymSetSearchPath" sptr, sptr
; SymSetSearchPath hProcess, SearchPathA ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; SearchPathA : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "dbghelp.dll"
#cfunc global SymSetSearchPath "SymSetSearchPath" sptr, str
; res = SymSetSearchPath(hProcess, SearchPathA)
; hProcess : HANDLE -> "sptr"
; SearchPathA : LPCSTR optional -> "str"; BOOL SymSetSearchPath(HANDLE hProcess, LPCSTR SearchPathA)
#uselib "dbghelp.dll"
#cfunc global SymSetSearchPath "SymSetSearchPath" intptr, str
; res = SymSetSearchPath(hProcess, SearchPathA)
; hProcess : HANDLE -> "intptr"
; SearchPathA : LPCSTR optional -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
procSymSetSearchPath = dbghelp.NewProc("SymSetSearchPath")
)
// hProcess (HANDLE), SearchPathA (LPCSTR optional)
r1, _, err := procSymSetSearchPath.Call(
uintptr(hProcess),
uintptr(unsafe.Pointer(windows.BytePtrFromString(SearchPathA))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SymSetSearchPath(
hProcess: THandle; // HANDLE
SearchPathA: PAnsiChar // LPCSTR optional
): BOOL; stdcall;
external 'dbghelp.dll' name 'SymSetSearchPath';result := DllCall("dbghelp\SymSetSearchPath"
, "Ptr", hProcess ; HANDLE
, "AStr", SearchPathA ; LPCSTR optional
, "Int") ; return: BOOL●SymSetSearchPath(hProcess, SearchPathA) = DLL("dbghelp.dll", "bool SymSetSearchPath(void*, char*)")
# 呼び出し: SymSetSearchPath(hProcess, SearchPathA)
# hProcess : HANDLE -> "void*"
# SearchPathA : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "dbghelp" fn SymSetSearchPath(
hProcess: ?*anyopaque, // HANDLE
SearchPathA: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;proc SymSetSearchPath(
hProcess: pointer, # HANDLE
SearchPathA: cstring # LPCSTR optional
): int32 {.importc: "SymSetSearchPath", stdcall, dynlib: "dbghelp.dll".}pragma(lib, "dbghelp");
extern(Windows)
int SymSetSearchPath(
void* hProcess, // HANDLE
const(char)* SearchPathA // LPCSTR optional
);ccall((:SymSetSearchPath, "dbghelp.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cstring),
hProcess, SearchPathA)
# hProcess : HANDLE -> Ptr{Cvoid}
# SearchPathA : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SymSetSearchPath(
void* hProcess,
const char* SearchPathA);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymSetSearchPath(hProcess, SearchPathA)
-- hProcess : HANDLE
-- SearchPathA : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymSetSearchPath = lib.func('__stdcall', 'SymSetSearchPath', 'int32_t', ['void *', 'str']);
// SymSetSearchPath(hProcess, SearchPathA)
// hProcess : HANDLE -> 'void *'
// SearchPathA : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("dbghelp.dll", {
SymSetSearchPath: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.SymSetSearchPath(hProcess, SearchPathA)
// hProcess : HANDLE -> "pointer"
// SearchPathA : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SymSetSearchPath(
void* hProcess,
const char* SearchPathA);
C, "dbghelp.dll");
// $ffi->SymSetSearchPath(hProcess, SearchPathA);
// hProcess : HANDLE
// SearchPathA : LPCSTR optional
// 構造体/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 SymSetSearchPath(
Pointer hProcess, // HANDLE
String SearchPathA // LPCSTR optional
);
}@[Link("dbghelp")]
lib Libdbghelp
fun SymSetSearchPath = SymSetSearchPath(
hProcess : Void*, # HANDLE
SearchPathA : UInt8* # LPCSTR optional
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SymSetSearchPathNative = Int32 Function(Pointer<Void>, Pointer<Utf8>);
typedef SymSetSearchPathDart = int Function(Pointer<Void>, Pointer<Utf8>);
final SymSetSearchPath = DynamicLibrary.open('dbghelp.dll')
.lookupFunction<SymSetSearchPathNative, SymSetSearchPathDart>('SymSetSearchPath');
// hProcess : HANDLE -> Pointer<Void>
// SearchPathA : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SymSetSearchPath(
hProcess: THandle; // HANDLE
SearchPathA: PAnsiChar // LPCSTR optional
): BOOL; stdcall;
external 'dbghelp.dll' name 'SymSetSearchPath';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SymSetSearchPath"
c_SymSetSearchPath :: Ptr () -> CString -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- SearchPathA : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let symsetsearchpath =
foreign "SymSetSearchPath"
((ptr void) @-> string @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* SearchPathA : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)
(cffi:defcfun ("SymSetSearchPath" sym-set-search-path :convention :stdcall) :int32
(h-process :pointer) ; HANDLE
(search-path-a :string)) ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SymSetSearchPath = Win32::API::More->new('dbghelp',
'BOOL SymSetSearchPath(HANDLE hProcess, LPCSTR SearchPathA)');
# my $ret = $SymSetSearchPath->Call($hProcess, $SearchPathA);
# hProcess : HANDLE -> HANDLE
# SearchPathA : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SymSetSearchPathW (Unicode版) — シンボル検索パスを設定する(Unicode版)。
公式の関連項目
- f SymGetSearchPath — シンボル検索パスを取得する。
- f SymInitialize — プロセスのシンボルハンドラを初期化する。