ホーム › System.Diagnostics.Debug › SymGetHomeDirectoryW

SymGetHomeDirectoryW

関数

シンボルハンドラのホームディレクトリを取得する。

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

シグネチャ

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

LPWSTR SymGetHomeDirectoryW(
    DWORD type,
    LPWSTR dir,
    UINT_PTR size
);

パラメーター

名前

型

方向

説明

type

DWORD

取得するディレクトリ。このパラメーターには、次のいずれかの値を指定できます。

値	意味
hdBase 0	ホームディレクトリ。
hdSrc 2	ソースディレクトリ。
hdSym 1	シンボルディレクトリ。

dir

LPWSTR

out

ディレクトリを受け取る文字列へのポインター。

size

UINT_PTR

出力バッファのサイズ(文字数単位)。

戻り値の型: LPWSTR

公式ドキュメント

SymGetHomeDirectoryW (Unicode) 関数は、Dbghelp が使用するホームディレクトリを取得します。

戻り値

関数が成功した場合、戻り値は dir パラメーターへのポインターです。

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

解説(Remarks)

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

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

メモ

dbghelp.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI バージョンと Unicode バージョンを自動的に選択するエイリアスとして SymGetHomeDirectory を定義します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「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>

LPWSTR SymGetHomeDirectoryW(
    DWORD type,
    LPWSTR dir,
    UINT_PTR size
);

[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymGetHomeDirectoryW(
    uint type,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder dir,   // LPWSTR out
    UIntPtr size   // UINT_PTR
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetHomeDirectoryW(
    type As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> dir As System.Text.StringBuilder,   ' LPWSTR out
    size As UIntPtr   ' UINT_PTR
) As IntPtr
End Function

' type : DWORD
' dir : LPWSTR out
' size : UINT_PTR
Declare PtrSafe Function SymGetHomeDirectoryW Lib "dbghelp" ( _
    ByVal type As Long, _
    ByVal dir As LongPtr, _
    ByVal size As LongPtr) As LongPtr
' 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

SymGetHomeDirectoryW = ctypes.windll.dbghelp.SymGetHomeDirectoryW
SymGetHomeDirectoryW.restype = wintypes.LPWSTR
SymGetHomeDirectoryW.argtypes = [
    wintypes.DWORD,  # type : DWORD
    wintypes.LPWSTR,  # dir : LPWSTR out
    ctypes.c_size_t,  # size : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetHomeDirectoryW = Fiddle::Function.new(
  lib['SymGetHomeDirectoryW'],
  [
    -Fiddle::TYPE_INT,  # type : DWORD
    Fiddle::TYPE_VOIDP,  # dir : LPWSTR out
    Fiddle::TYPE_UINTPTR_T,  # size : UINT_PTR
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetHomeDirectoryW(
        type: u32,  // DWORD
        dir: *mut u16,  // LPWSTR out
        size: usize  // UINT_PTR
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr SymGetHomeDirectoryW(uint type, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder dir, UIntPtr size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetHomeDirectoryW' -Namespace Win32 -PassThru
# $api::SymGetHomeDirectoryW(type, dir, size)

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

出力引数:

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