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

SymGetSourceVarFromTokenW

関数
トークンからソース変数の値を取得する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymGetSourceVarFromTokenW(
    HANDLE hProcess,
    void* Token,
    LPCWSTR Params,   // optional
    LPCWSTR VarName,
    LPWSTR Value,
    DWORD Size
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
Tokenvoid*inトークンへのポインター。
ParamsLPCWSTRinoptionalこのパラメーターは使用されません。
VarNameLPCWSTRin値を取得したい変数トークンの名前。
ValueLPWSTRoutVarName パラメーターで指定された変数トークンに関連付けられた値を受け取る バッファーへのポインター。
SizeDWORDinValue バッファーのサイズ(文字単位)。

戻り値の型: BOOL

公式ドキュメント

SymGetSourceVarFromTokenW (Unicode) 関数は、Source Server トークンから、指定された変数名に関連付けられた値を取得します。

戻り値

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

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

解説(Remarks)

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

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

メモ

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

BOOL SymGetSourceVarFromTokenW(
    HANDLE hProcess,
    void* Token,
    LPCWSTR Params,   // optional
    LPCWSTR VarName,
    LPWSTR Value,
    DWORD Size
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetSourceVarFromTokenW(
    IntPtr hProcess,   // HANDLE
    IntPtr Token,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string Params,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string VarName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Value,   // LPWSTR out
    uint Size   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetSourceVarFromTokenW(
    hProcess As IntPtr,   ' HANDLE
    Token As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> Params As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> VarName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> Value As System.Text.StringBuilder,   ' LPWSTR out
    Size As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' Token : void*
' Params : LPCWSTR optional
' VarName : LPCWSTR
' Value : LPWSTR out
' Size : DWORD
Declare PtrSafe Function SymGetSourceVarFromTokenW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Token As LongPtr, _
    ByVal Params As LongPtr, _
    ByVal VarName As LongPtr, _
    ByVal Value As LongPtr, _
    ByVal Size As Long) 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

SymGetSourceVarFromTokenW = ctypes.windll.dbghelp.SymGetSourceVarFromTokenW
SymGetSourceVarFromTokenW.restype = wintypes.BOOL
SymGetSourceVarFromTokenW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(None),  # Token : void*
    wintypes.LPCWSTR,  # Params : LPCWSTR optional
    wintypes.LPCWSTR,  # VarName : LPCWSTR
    wintypes.LPWSTR,  # Value : LPWSTR out
    wintypes.DWORD,  # Size : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetSourceVarFromTokenW = Fiddle::Function.new(
  lib['SymGetSourceVarFromTokenW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # Token : void*
    Fiddle::TYPE_VOIDP,  # Params : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # VarName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Value : LPWSTR out
    -Fiddle::TYPE_INT,  # Size : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSourceVarFromTokenW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Token: *mut (),  // void*
        Params: *const u16,  // LPCWSTR optional
        VarName: *const u16,  // LPCWSTR
        Value: *mut u16,  // LPWSTR out
        Size: u32  // DWORD
    ) -> 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 SymGetSourceVarFromTokenW(IntPtr hProcess, IntPtr Token, [MarshalAs(UnmanagedType.LPWStr)] string Params, [MarshalAs(UnmanagedType.LPWStr)] string VarName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Value, uint Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSourceVarFromTokenW' -Namespace Win32 -PassThru
# $api::SymGetSourceVarFromTokenW(hProcess, Token, Params, VarName, Value, Size)
#uselib "dbghelp.dll"
#func global SymGetSourceVarFromTokenW "SymGetSourceVarFromTokenW" wptr, wptr, wptr, wptr, wptr, wptr
; SymGetSourceVarFromTokenW hProcess, Token, Params, VarName, varptr(Value), Size   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; Token : void* -> "wptr"
; Params : LPCWSTR optional -> "wptr"
; VarName : LPCWSTR -> "wptr"
; Value : LPWSTR out -> "wptr"
; Size : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymGetSourceVarFromTokenW "SymGetSourceVarFromTokenW" sptr, sptr, wstr, wstr, var, int
; res = SymGetSourceVarFromTokenW(hProcess, Token, Params, VarName, Value, Size)
; hProcess : HANDLE -> "sptr"
; Token : void* -> "sptr"
; Params : LPCWSTR optional -> "wstr"
; VarName : LPCWSTR -> "wstr"
; Value : LPWSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SymGetSourceVarFromTokenW(HANDLE hProcess, void* Token, LPCWSTR Params, LPCWSTR VarName, LPWSTR Value, DWORD Size)
#uselib "dbghelp.dll"
#cfunc global SymGetSourceVarFromTokenW "SymGetSourceVarFromTokenW" intptr, intptr, wstr, wstr, var, int
; res = SymGetSourceVarFromTokenW(hProcess, Token, Params, VarName, Value, Size)
; hProcess : HANDLE -> "intptr"
; Token : void* -> "intptr"
; Params : LPCWSTR optional -> "wstr"
; VarName : LPCWSTR -> "wstr"
; Value : LPWSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetSourceVarFromTokenW = dbghelp.NewProc("SymGetSourceVarFromTokenW")
)

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

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

typedef SymGetSourceVarFromTokenWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef SymGetSourceVarFromTokenWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int);
final SymGetSourceVarFromTokenW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetSourceVarFromTokenWNative, SymGetSourceVarFromTokenWDart>('SymGetSourceVarFromTokenW');
// hProcess : HANDLE -> Pointer<Void>
// Token : void* -> Pointer<Void>
// Params : LPCWSTR optional -> Pointer<Utf16>
// VarName : LPCWSTR -> Pointer<Utf16>
// Value : LPWSTR out -> Pointer<Utf16>
// Size : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymGetSourceVarFromTokenW(
  hProcess: THandle;   // HANDLE
  Token: Pointer;   // void*
  Params: PWideChar;   // LPCWSTR optional
  VarName: PWideChar;   // LPCWSTR
  Value: PWideChar;   // LPWSTR out
  Size: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymGetSourceVarFromTokenW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymGetSourceVarFromTokenW"
  c_SymGetSourceVarFromTokenW :: Ptr () -> Ptr () -> CWString -> CWString -> CWString -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Token : void* -> Ptr ()
-- Params : LPCWSTR optional -> CWString
-- VarName : LPCWSTR -> CWString
-- Value : LPWSTR out -> CWString
-- Size : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symgetsourcevarfromtokenw =
  foreign "SymGetSourceVarFromTokenW"
    ((ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Token : void* -> (ptr void) *)
(* Params : LPCWSTR optional -> (ptr uint16_t) *)
(* VarName : LPCWSTR -> (ptr uint16_t) *)
(* Value : LPWSTR out -> (ptr uint16_t) *)
(* Size : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymGetSourceVarFromTokenW" sym-get-source-var-from-token-w :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (token :pointer)   ; void*
  (params (:string :encoding :utf-16le))   ; LPCWSTR optional
  (var-name (:string :encoding :utf-16le))   ; LPCWSTR
  (value :pointer)   ; LPWSTR out
  (size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetSourceVarFromTokenW = Win32::API::More->new('dbghelp',
    'BOOL SymGetSourceVarFromTokenW(HANDLE hProcess, LPVOID Token, LPCWSTR Params, LPCWSTR VarName, LPWSTR Value, DWORD Size)');
# my $ret = $SymGetSourceVarFromTokenW->Call($hProcess, $Token, $Params, $VarName, $Value, $Size);
# hProcess : HANDLE -> HANDLE
# Token : void* -> LPVOID
# Params : LPCWSTR optional -> LPCWSTR
# VarName : LPCWSTR -> LPCWSTR
# Value : LPWSTR out -> LPWSTR
# Size : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。