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

SymGetHomeDirectory

関数
シンボルハンドラのホームディレクトリを取得する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

LPSTR SymGetHomeDirectory(
    DWORD type,
    LPSTR dir,
    UINT_PTR size
);

パラメーター

名前方向説明
typeDWORDin

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

意味
hdBase
0
ホームディレクトリ。
hdSrc
2
ソースディレクトリ。
hdSym
1
シンボルディレクトリ。
dirLPSTRoutディレクトリを受け取る文字列へのポインターです。
sizeUINT_PTRin出力バッファーのサイズ(文字単位)です。

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

この関数を含むすべての 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>

LPSTR SymGetHomeDirectory(
    DWORD type,
    LPSTR dir,
    UINT_PTR size
);
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymGetHomeDirectory(
    uint type,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder dir,   // LPSTR out
    UIntPtr size   // UINT_PTR
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetHomeDirectory(
    type As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> dir As System.Text.StringBuilder,   ' LPSTR out
    size As UIntPtr   ' UINT_PTR
) As IntPtr
End Function
' type : DWORD
' dir : LPSTR out
' size : UINT_PTR
Declare PtrSafe Function SymGetHomeDirectory Lib "dbghelp" ( _
    ByVal type As Long, _
    ByVal dir As String, _
    ByVal size As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymGetHomeDirectory = ctypes.windll.dbghelp.SymGetHomeDirectory
SymGetHomeDirectory.restype = wintypes.LPSTR
SymGetHomeDirectory.argtypes = [
    wintypes.DWORD,  # type : DWORD
    wintypes.LPSTR,  # dir : LPSTR 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')
SymGetHomeDirectory = Fiddle::Function.new(
  lib['SymGetHomeDirectory'],
  [
    -Fiddle::TYPE_INT,  # type : DWORD
    Fiddle::TYPE_VOIDP,  # dir : LPSTR out
    Fiddle::TYPE_UINTPTR_T,  # size : UINT_PTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "dbghelp")]
extern "system" {
    fn SymGetHomeDirectory(
        type: u32,  // DWORD
        dir: *mut u8,  // LPSTR out
        size: usize  // UINT_PTR
    ) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr SymGetHomeDirectory(uint type, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder dir, UIntPtr size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetHomeDirectory' -Namespace Win32 -PassThru
# $api::SymGetHomeDirectory(type, dir, size)
#uselib "dbghelp.dll"
#func global SymGetHomeDirectory "SymGetHomeDirectory" sptr, sptr, sptr
; SymGetHomeDirectory type, varptr(dir), size   ; 戻り値は stat
; type : DWORD -> "sptr"
; dir : LPSTR out -> "sptr"
; size : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymGetHomeDirectory "SymGetHomeDirectory" int, var, sptr
; res = SymGetHomeDirectory(type, dir, size)
; type : DWORD -> "int"
; dir : LPSTR out -> "var"
; size : UINT_PTR -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; LPSTR SymGetHomeDirectory(DWORD type, LPSTR dir, UINT_PTR size)
#uselib "dbghelp.dll"
#cfunc global SymGetHomeDirectory "SymGetHomeDirectory" int, var, intptr
; res = SymGetHomeDirectory(type, dir, size)
; type : DWORD -> "int"
; dir : LPSTR out -> "var"
; size : UINT_PTR -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetHomeDirectory = dbghelp.NewProc("SymGetHomeDirectory")
)

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

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

typedef SymGetHomeDirectoryNative = Pointer<Utf8> Function(Uint32, Pointer<Utf8>, UintPtr);
typedef SymGetHomeDirectoryDart = Pointer<Utf8> Function(int, Pointer<Utf8>, int);
final SymGetHomeDirectory = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetHomeDirectoryNative, SymGetHomeDirectoryDart>('SymGetHomeDirectory');
// type : DWORD -> Uint32
// dir : LPSTR out -> Pointer<Utf8>
// size : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymGetHomeDirectory(
  type: DWORD;   // DWORD
  dir: PAnsiChar;   // LPSTR out
  size: NativeUInt   // UINT_PTR
): PAnsiChar; stdcall;
  external 'dbghelp.dll' name 'SymGetHomeDirectory';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymGetHomeDirectory"
  c_SymGetHomeDirectory :: Word32 -> CString -> CUIntPtr -> IO CString
-- type : DWORD -> Word32
-- dir : LPSTR out -> CString
-- size : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symgethomedirectory =
  foreign "SymGetHomeDirectory"
    (uint32_t @-> string @-> size_t @-> returning string)
(* type : DWORD -> uint32_t *)
(* dir : LPSTR out -> string *)
(* size : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymGetHomeDirectory" sym-get-home-directory :convention :stdcall) :string
  (type :uint32)   ; DWORD
  (dir :pointer)   ; LPSTR out
  (size :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetHomeDirectory = Win32::API::More->new('dbghelp',
    'LPSTR SymGetHomeDirectory(DWORD type, LPSTR dir, WPARAM size)');
# my $ret = $SymGetHomeDirectory->Call($type, $dir, $size);
# type : DWORD -> DWORD
# dir : LPSTR out -> LPSTR
# size : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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