ホーム › System.Diagnostics.Debug › SymGetSearchPathW

SymGetSearchPathW

関数

シンボル検索パスを取得する(Unicode版)。

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

シグネチャ

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymGetSearchPathW(
    HANDLE hProcess,
    LPWSTR SearchPathA,
    DWORD SearchPathLength
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	元々 SymInitialize 関数に渡されたプロセスのハンドル。
SearchPathA	LPWSTR	out	現在のシンボル検索パスを受け取るワイド文字バッファ。
SearchPathLength	DWORD	in	SearchPath バッファーのサイズ(文字数単位)。

戻り値の型: BOOL

公式ドキュメント

SymGetSearchPathW (Unicode) 関数は、指定したプロセスのシンボル検索パスを取得します。

戻り値

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

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

解説(Remarks)

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

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

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

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

メモ

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

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

各言語での呼び出し定義

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymGetSearchPathW(
    HANDLE hProcess,
    LPWSTR SearchPathA,
    DWORD SearchPathLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetSearchPathW(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder SearchPathA,   // LPWSTR out
    uint SearchPathLength   // DWORD
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetSearchPathW(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> SearchPathA As System.Text.StringBuilder,   ' LPWSTR out
    SearchPathLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' SearchPathA : LPWSTR out
' SearchPathLength : DWORD
Declare PtrSafe Function SymGetSearchPathW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal SearchPathA As LongPtr, _
    ByVal SearchPathLength As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymGetSearchPathW = ctypes.windll.dbghelp.SymGetSearchPathW
SymGetSearchPathW.restype = wintypes.BOOL
SymGetSearchPathW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPWSTR,  # SearchPathA : LPWSTR 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')
SymGetSearchPathW = Fiddle::Function.new(
  lib['SymGetSearchPathW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # SearchPathA : LPWSTR out
    -Fiddle::TYPE_INT,  # SearchPathLength : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSearchPathW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        SearchPathA: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool SymGetSearchPathW(IntPtr hProcess, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder SearchPathA, uint SearchPathLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSearchPathW' -Namespace Win32 -PassThru
# $api::SymGetSearchPathW(hProcess, SearchPathA, SearchPathLength)

#uselib "dbghelp.dll"
#func global SymGetSearchPathW "SymGetSearchPathW" wptr, wptr, wptr
; SymGetSearchPathW hProcess, varptr(SearchPathA), SearchPathLength   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; SearchPathA : LPWSTR out -> "wptr"
; SearchPathLength : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymGetSearchPathW "SymGetSearchPathW" sptr, var, int
; res = SymGetSearchPathW(hProcess, SearchPathA, SearchPathLength)
; hProcess : HANDLE -> "sptr"
; SearchPathA : LPWSTR out -> "var"
; SearchPathLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global SymGetSearchPathW "SymGetSearchPathW" sptr, sptr, int
; res = SymGetSearchPathW(hProcess, varptr(SearchPathA), SearchPathLength)
; hProcess : HANDLE -> "sptr"
; SearchPathA : LPWSTR out -> "sptr"
; SearchPathLength : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。