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

SymSetHomeDirectoryW

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

シグネチャ

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

LPWSTR SymSetHomeDirectoryW(
    HANDLE hProcess,   // optional
    LPCWSTR dir   // optional
);

パラメーター

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

戻り値の型: LPWSTR

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SymSetHomeDirectoryW(
    HANDLE hProcess,   // optional
    LPCWSTR dir   // optional
);
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymSetHomeDirectoryW(
    IntPtr hProcess,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string dir   // LPCWSTR optional
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSetHomeDirectoryW(
    hProcess As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> dir As String   ' LPCWSTR optional
) As IntPtr
End Function
' hProcess : HANDLE optional
' dir : LPCWSTR optional
Declare PtrSafe Function SymSetHomeDirectoryW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal dir 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

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

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSetHomeDirectoryW = dbghelp.NewProc("SymSetHomeDirectoryW")
)

// hProcess (HANDLE optional), dir (LPCWSTR optional)
r1, _, err := procSymSetHomeDirectoryW.Call(
	uintptr(hProcess),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(dir))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function SymSetHomeDirectoryW(
  hProcess: THandle;   // HANDLE optional
  dir: PWideChar   // LPCWSTR optional
): PWideChar; stdcall;
  external 'dbghelp.dll' name 'SymSetHomeDirectoryW';
result := DllCall("dbghelp\SymSetHomeDirectoryW"
    , "Ptr", hProcess   ; HANDLE optional
    , "WStr", dir   ; LPCWSTR optional
    , "Ptr")   ; return: LPWSTR
●SymSetHomeDirectoryW(hProcess, dir) = DLL("dbghelp.dll", "char* SymSetHomeDirectoryW(void*, char*)")
# 呼び出し: SymSetHomeDirectoryW(hProcess, dir)
# hProcess : HANDLE optional -> "void*"
# dir : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "dbghelp" fn SymSetHomeDirectoryW(
    hProcess: ?*anyopaque, // HANDLE optional
    dir: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) [*c]const u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SymSetHomeDirectoryW(
    hProcess: pointer,  # HANDLE optional
    dir: WideCString  # LPCWSTR optional
): WideCString {.importc: "SymSetHomeDirectoryW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
const(wchar)* SymSetHomeDirectoryW(
    void* hProcess,   // HANDLE optional
    const(wchar)* dir   // LPCWSTR optional
);
ccall((:SymSetHomeDirectoryW, "dbghelp.dll"), stdcall, Cwstring,
      (Ptr{Cvoid}, Cwstring),
      hProcess, dir)
# hProcess : HANDLE optional -> Ptr{Cvoid}
# dir : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
const uint16_t* SymSetHomeDirectoryW(
    void* hProcess,
    const uint16_t* dir);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymSetHomeDirectoryW(hProcess, dir)
-- hProcess : HANDLE optional
-- dir : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymSetHomeDirectoryW = lib.func('__stdcall', 'SymSetHomeDirectoryW', 'void *', ['void *', 'str16']);
// SymSetHomeDirectoryW(hProcess, dir)
// hProcess : HANDLE optional -> 'void *'
// dir : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymSetHomeDirectoryW: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.SymSetHomeDirectoryW(hProcess, dir)
// hProcess : HANDLE optional -> "pointer"
// dir : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const uint16_t* SymSetHomeDirectoryW(
    void* hProcess,
    const uint16_t* dir);
C, "dbghelp.dll");
// $ffi->SymSetHomeDirectoryW(hProcess, dir);
// hProcess : HANDLE optional
// dir : LPCWSTR 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.UNICODE_OPTIONS);
    Pointer SymSetHomeDirectoryW(
        Pointer hProcess,   // HANDLE optional
        WString dir   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun SymSetHomeDirectoryW = SymSetHomeDirectoryW(
    hProcess : Void*,   # HANDLE optional
    dir : UInt16*   # LPCWSTR optional
  ) : UInt16*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let symsethomedirectoryw =
  foreign "SymSetHomeDirectoryW"
    ((ptr void) @-> (ptr uint16_t) @-> returning (ptr uint16_t))
(* hProcess : HANDLE optional -> (ptr void) *)
(* dir : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymSetHomeDirectoryW" sym-set-home-directory-w :convention :stdcall) (:string :encoding :utf-16le)
  (h-process :pointer)   ; HANDLE optional
  (dir (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSetHomeDirectoryW = Win32::API::More->new('dbghelp',
    'LPWSTR SymSetHomeDirectoryW(HANDLE hProcess, LPCWSTR dir)');
# my $ret = $SymSetHomeDirectoryW->Call($hProcess, $dir);
# hProcess : HANDLE optional -> HANDLE
# dir : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

公式の関連項目