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

SymGetSearchPath

関数
シンボル検索パスを取得する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymGetSearchPath(
    HANDLE hProcess,
    LPSTR SearchPathA,
    DWORD SearchPathLength
);

パラメーター

名前方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡されたプロセスのハンドル。
SearchPathALPSTRout現在のシンボル検索パスを受け取るバッファ。
SearchPathLengthDWORDinSearchPath バッファーのサイズ (文字数単位)。

戻り値の型: BOOL

公式ドキュメント

SymGetSearchPath 関数 (dbghelp.h) は、指定されたプロセスのシンボル検索パスを取得します。

戻り値

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

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

解説(Remarks)

SymGetSearchPath 関数は、指定されたプロセスのシンボル検索パスを SearchPath バッファーにコピーします。関数が失敗した場合、バッファーの内容は未定義です。

プロセスのシンボル検索パスを指定するには、 SymSetSearchPath 関数を使用します。

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

SymGetSearchPath = ctypes.windll.dbghelp.SymGetSearchPath
SymGetSearchPath.restype = wintypes.BOOL
SymGetSearchPath.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPSTR,  # SearchPathA : LPSTR out
    wintypes.DWORD,  # SearchPathLength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetSearchPath = Fiddle::Function.new(
  lib['SymGetSearchPath'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # SearchPathA : LPSTR out
    -Fiddle::TYPE_INT,  # SearchPathLength : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSearchPath(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        SearchPathA: *mut u8,  // LPSTR out
        SearchPathLength: u32  // DWORD
    ) -> 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 SymGetSearchPath(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder SearchPathA, uint SearchPathLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSearchPath' -Namespace Win32 -PassThru
# $api::SymGetSearchPath(hProcess, SearchPathA, SearchPathLength)
#uselib "dbghelp.dll"
#func global SymGetSearchPath "SymGetSearchPath" sptr, sptr, sptr
; SymGetSearchPath hProcess, varptr(SearchPathA), SearchPathLength   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; SearchPathA : LPSTR out -> "sptr"
; SearchPathLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymGetSearchPath "SymGetSearchPath" sptr, var, int
; res = SymGetSearchPath(hProcess, SearchPathA, SearchPathLength)
; hProcess : HANDLE -> "sptr"
; SearchPathA : LPSTR out -> "var"
; SearchPathLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SymGetSearchPath(HANDLE hProcess, LPSTR SearchPathA, DWORD SearchPathLength)
#uselib "dbghelp.dll"
#cfunc global SymGetSearchPath "SymGetSearchPath" intptr, var, int
; res = SymGetSearchPath(hProcess, SearchPathA, SearchPathLength)
; hProcess : HANDLE -> "intptr"
; SearchPathA : LPSTR out -> "var"
; SearchPathLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetSearchPath = dbghelp.NewProc("SymGetSearchPath")
)

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

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

typedef SymGetSearchPathNative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32);
typedef SymGetSearchPathDart = int Function(Pointer<Void>, Pointer<Utf8>, int);
final SymGetSearchPath = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetSearchPathNative, SymGetSearchPathDart>('SymGetSearchPath');
// hProcess : HANDLE -> Pointer<Void>
// SearchPathA : LPSTR out -> Pointer<Utf8>
// SearchPathLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymGetSearchPath(
  hProcess: THandle;   // HANDLE
  SearchPathA: PAnsiChar;   // LPSTR out
  SearchPathLength: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymGetSearchPath';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymGetSearchPath"
  c_SymGetSearchPath :: Ptr () -> CString -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- SearchPathA : LPSTR out -> CString
-- SearchPathLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symgetsearchpath =
  foreign "SymGetSearchPath"
    ((ptr void) @-> string @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* SearchPathA : LPSTR out -> string *)
(* SearchPathLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymGetSearchPath" sym-get-search-path :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (search-path-a :pointer)   ; LPSTR out
  (search-path-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetSearchPath = Win32::API::More->new('dbghelp',
    'BOOL SymGetSearchPath(HANDLE hProcess, LPSTR SearchPathA, DWORD SearchPathLength)');
# my $ret = $SymGetSearchPath->Call($hProcess, $SearchPathA, $SearchPathLength);
# hProcess : HANDLE -> HANDLE
# SearchPathA : LPSTR out -> LPSTR
# SearchPathLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目