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

SymSetSearchPathW

関数
シンボル検索パスを設定する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymSetSearchPathW(
    HANDLE hProcess,
    LPCWSTR SearchPathA   // optional
);

パラメーター

名前方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡されたプロセスへのハンドルです。
SearchPathALPCWSTRinoptional新たに設定するシンボル検索パスのワイド文字列。セミコロン区切り。NULL可。

戻り値の型: BOOL

公式ドキュメント

SymSetSearchPathW (Unicode) 関数 (dbghelp.h) は、指定されたプロセスの検索パスを設定します。

戻り値

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

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

解説(Remarks)

シンボル検索パスは、ライブラリがアプリケーションで使用されている間、何度でも変更できます。変更は、シンボルハンドラーへの以降のすべての呼び出しに影響します。

現在の検索パスを取得するには、 SymGetSearchPath 関数を呼び出します。

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

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

メモ

dbghelp.h ヘッダーは、SymSetSearchPath を、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>

BOOL SymSetSearchPathW(
    HANDLE hProcess,
    LPCWSTR SearchPathA   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymSetSearchPathW(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string SearchPathA   // LPCWSTR optional
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSetSearchPathW(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> SearchPathA As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' SearchPathA : LPCWSTR optional
Declare PtrSafe Function SymSetSearchPathW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal SearchPathA As LongPtr) 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

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

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSetSearchPathW = dbghelp.NewProc("SymSetSearchPathW")
)

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

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

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

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

let symsetsearchpathw =
  foreign "SymSetSearchPathW"
    ((ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* SearchPathA : 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 ("SymSetSearchPathW" sym-set-search-path-w :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (search-path-a (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSetSearchPathW = Win32::API::More->new('dbghelp',
    'BOOL SymSetSearchPathW(HANDLE hProcess, LPCWSTR SearchPathA)');
# my $ret = $SymSetSearchPathW->Call($hProcess, $SearchPathA);
# hProcess : HANDLE -> HANDLE
# SearchPathA : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

公式の関連項目