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

SymSetHomeDirectory

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

シグネチャ

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

LPSTR SymSetHomeDirectory(
    HANDLE hProcess,   // optional
    LPCSTR dir   // optional
);

パラメーター

名前方向説明
hProcessHANDLEinoptionalプロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
dirLPCSTRinoptionalホームディレクトリ。このディレクトリは書き込み可能である必要があります。そうでない場合、ホームディレクトリは CSIDL_COMMON_APPDATA で指定される共通アプリケーションディレクトリになります。このパラメーターが NULL の場合、関数は既定のディレクトリを使用します。

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

既定のホームディレクトリは、Dbghelp.dll が存在するディレクトリです。Dbghelp はこのディレクトリを、既定のダウンストリームストアディレクトリ (ホームディレクトリの sym サブディレクトリ) など、他のディレクトリの基準として使用します。

既定のシンボルストアおよびソースサーバーキャッシュの場所に使用されるホームディレクトリは、DBGHELP_HOMEDIR 環境変数に格納されます。

この関数を含むすべての 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 SymSetHomeDirectory(
    HANDLE hProcess,   // optional
    LPCSTR dir   // optional
);
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymSetHomeDirectory(
    IntPtr hProcess,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPStr)] string dir   // LPCSTR optional
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSetHomeDirectory(
    hProcess As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPStr)> dir As String   ' LPCSTR optional
) As IntPtr
End Function
' hProcess : HANDLE optional
' dir : LPCSTR optional
Declare PtrSafe Function SymSetHomeDirectory Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal dir As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymSetHomeDirectory = ctypes.windll.dbghelp.SymSetHomeDirectory
SymSetHomeDirectory.restype = wintypes.LPSTR
SymSetHomeDirectory.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE optional
    wintypes.LPCSTR,  # dir : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymSetHomeDirectory = Fiddle::Function.new(
  lib['SymSetHomeDirectory'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE optional
    Fiddle::TYPE_VOIDP,  # dir : LPCSTR optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "dbghelp")]
extern "system" {
    fn SymSetHomeDirectory(
        hProcess: *mut core::ffi::c_void,  // HANDLE optional
        dir: *const u8  // LPCSTR optional
    ) -> *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 SymSetHomeDirectory(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string dir);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSetHomeDirectory' -Namespace Win32 -PassThru
# $api::SymSetHomeDirectory(hProcess, dir)
#uselib "dbghelp.dll"
#func global SymSetHomeDirectory "SymSetHomeDirectory" sptr, sptr
; SymSetHomeDirectory hProcess, dir   ; 戻り値は stat
; hProcess : HANDLE optional -> "sptr"
; dir : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymSetHomeDirectory "SymSetHomeDirectory" sptr, str
; res = SymSetHomeDirectory(hProcess, dir)
; hProcess : HANDLE optional -> "sptr"
; dir : LPCSTR optional -> "str"
; LPSTR SymSetHomeDirectory(HANDLE hProcess, LPCSTR dir)
#uselib "dbghelp.dll"
#cfunc global SymSetHomeDirectory "SymSetHomeDirectory" intptr, str
; res = SymSetHomeDirectory(hProcess, dir)
; hProcess : HANDLE optional -> "intptr"
; dir : LPCSTR optional -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSetHomeDirectory = dbghelp.NewProc("SymSetHomeDirectory")
)

// hProcess (HANDLE optional), dir (LPCSTR optional)
r1, _, err := procSymSetHomeDirectory.Call(
	uintptr(hProcess),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(dir))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPSTR
function SymSetHomeDirectory(
  hProcess: THandle;   // HANDLE optional
  dir: PAnsiChar   // LPCSTR optional
): PAnsiChar; stdcall;
  external 'dbghelp.dll' name 'SymSetHomeDirectory';
result := DllCall("dbghelp\SymSetHomeDirectory"
    , "Ptr", hProcess   ; HANDLE optional
    , "AStr", dir   ; LPCSTR optional
    , "Ptr")   ; return: LPSTR
●SymSetHomeDirectory(hProcess, dir) = DLL("dbghelp.dll", "char* SymSetHomeDirectory(void*, char*)")
# 呼び出し: SymSetHomeDirectory(hProcess, dir)
# hProcess : HANDLE optional -> "void*"
# dir : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SymSetHomeDirectoryNative = Pointer<Utf8> Function(Pointer<Void>, Pointer<Utf8>);
typedef SymSetHomeDirectoryDart = Pointer<Utf8> Function(Pointer<Void>, Pointer<Utf8>);
final SymSetHomeDirectory = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymSetHomeDirectoryNative, SymSetHomeDirectoryDart>('SymSetHomeDirectory');
// hProcess : HANDLE optional -> Pointer<Void>
// dir : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymSetHomeDirectory(
  hProcess: THandle;   // HANDLE optional
  dir: PAnsiChar   // LPCSTR optional
): PAnsiChar; stdcall;
  external 'dbghelp.dll' name 'SymSetHomeDirectory';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymSetHomeDirectory"
  c_SymSetHomeDirectory :: Ptr () -> CString -> IO CString
-- hProcess : HANDLE optional -> Ptr ()
-- dir : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symsethomedirectory =
  foreign "SymSetHomeDirectory"
    ((ptr void) @-> string @-> returning string)
(* hProcess : HANDLE optional -> (ptr void) *)
(* dir : 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 ("SymSetHomeDirectory" sym-set-home-directory :convention :stdcall) :string
  (h-process :pointer)   ; HANDLE optional
  (dir :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSetHomeDirectory = Win32::API::More->new('dbghelp',
    'LPSTR SymSetHomeDirectory(HANDLE hProcess, LPCSTR dir)');
# my $ret = $SymSetHomeDirectory->Call($hProcess, $dir);
# hProcess : HANDLE optional -> HANDLE
# dir : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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