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

SymGetSourceVarFromToken

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

シグネチャ

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

BOOL SymGetSourceVarFromToken(
    HANDLE hProcess,
    void* Token,
    LPCSTR Params,   // optional
    LPCSTR VarName,
    LPSTR Value,
    DWORD Size
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 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>

BOOL SymGetSourceVarFromToken(
    HANDLE hProcess,
    void* Token,
    LPCSTR Params,   // optional
    LPCSTR VarName,
    LPSTR Value,
    DWORD Size
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetSourceVarFromToken(
    IntPtr hProcess,   // HANDLE
    IntPtr Token,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string Params,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string VarName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Value,   // LPSTR out
    uint Size   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetSourceVarFromToken(
    hProcess As IntPtr,   ' HANDLE
    Token As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> Params As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> VarName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> Value As System.Text.StringBuilder,   ' LPSTR out
    Size As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' Token : void*
' Params : LPCSTR optional
' VarName : LPCSTR
' Value : LPSTR out
' Size : DWORD
Declare PtrSafe Function SymGetSourceVarFromToken Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Token As LongPtr, _
    ByVal Params As String, _
    ByVal VarName As String, _
    ByVal Value As String, _
    ByVal Size As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymGetSourceVarFromToken = ctypes.windll.dbghelp.SymGetSourceVarFromToken
SymGetSourceVarFromToken.restype = wintypes.BOOL
SymGetSourceVarFromToken.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(None),  # Token : void*
    wintypes.LPCSTR,  # Params : LPCSTR optional
    wintypes.LPCSTR,  # VarName : LPCSTR
    wintypes.LPSTR,  # Value : LPSTR 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')
SymGetSourceVarFromToken = Fiddle::Function.new(
  lib['SymGetSourceVarFromToken'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # Token : void*
    Fiddle::TYPE_VOIDP,  # Params : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # VarName : LPCSTR
    Fiddle::TYPE_VOIDP,  # Value : LPSTR out
    -Fiddle::TYPE_INT,  # Size : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSourceVarFromToken(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Token: *mut (),  // void*
        Params: *const u8,  // LPCSTR optional
        VarName: *const u8,  // LPCSTR
        Value: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool SymGetSourceVarFromToken(IntPtr hProcess, IntPtr Token, [MarshalAs(UnmanagedType.LPStr)] string Params, [MarshalAs(UnmanagedType.LPStr)] string VarName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Value, uint Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSourceVarFromToken' -Namespace Win32 -PassThru
# $api::SymGetSourceVarFromToken(hProcess, Token, Params, VarName, Value, Size)
#uselib "dbghelp.dll"
#func global SymGetSourceVarFromToken "SymGetSourceVarFromToken" sptr, sptr, sptr, sptr, sptr, sptr
; SymGetSourceVarFromToken hProcess, Token, Params, VarName, varptr(Value), Size   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Token : void* -> "sptr"
; Params : LPCSTR optional -> "sptr"
; VarName : LPCSTR -> "sptr"
; Value : LPSTR out -> "sptr"
; Size : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymGetSourceVarFromToken "SymGetSourceVarFromToken" sptr, sptr, str, str, var, int
; res = SymGetSourceVarFromToken(hProcess, Token, Params, VarName, Value, Size)
; hProcess : HANDLE -> "sptr"
; Token : void* -> "sptr"
; Params : LPCSTR optional -> "str"
; VarName : LPCSTR -> "str"
; Value : LPSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SymGetSourceVarFromToken(HANDLE hProcess, void* Token, LPCSTR Params, LPCSTR VarName, LPSTR Value, DWORD Size)
#uselib "dbghelp.dll"
#cfunc global SymGetSourceVarFromToken "SymGetSourceVarFromToken" intptr, intptr, str, str, var, int
; res = SymGetSourceVarFromToken(hProcess, Token, Params, VarName, Value, Size)
; hProcess : HANDLE -> "intptr"
; Token : void* -> "intptr"
; Params : LPCSTR optional -> "str"
; VarName : LPCSTR -> "str"
; Value : LPSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetSourceVarFromToken = dbghelp.NewProc("SymGetSourceVarFromToken")
)

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

extern "dbghelp" fn SymGetSourceVarFromToken(
    hProcess: ?*anyopaque, // HANDLE
    Token: ?*anyopaque, // void*
    Params: [*c]const u8, // LPCSTR optional
    VarName: [*c]const u8, // LPCSTR
    Value: [*c]u8, // LPSTR out
    Size: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SymGetSourceVarFromToken(
    hProcess: pointer,  # HANDLE
    Token: pointer,  # void*
    Params: cstring,  # LPCSTR optional
    VarName: cstring,  # LPCSTR
    Value: ptr char,  # LPSTR out
    Size: uint32  # DWORD
): int32 {.importc: "SymGetSourceVarFromToken", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymGetSourceVarFromToken(
    void* hProcess,   // HANDLE
    void* Token,   // void*
    const(char)* Params,   // LPCSTR optional
    const(char)* VarName,   // LPCSTR
    char* Value,   // LPSTR out
    uint Size   // DWORD
);
ccall((:SymGetSourceVarFromToken, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Cstring, Cstring, Ptr{UInt8}, UInt32),
      hProcess, Token, Params, VarName, Value, Size)
# hProcess : HANDLE -> Ptr{Cvoid}
# Token : void* -> Ptr{Cvoid}
# Params : LPCSTR optional -> Cstring
# VarName : LPCSTR -> Cstring
# Value : LPSTR out -> Ptr{UInt8}
# Size : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymGetSourceVarFromToken(
    void* hProcess,
    void* Token,
    const char* Params,
    const char* VarName,
    char* Value,
    uint32_t Size);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymGetSourceVarFromToken(hProcess, Token, Params, VarName, Value, Size)
-- hProcess : HANDLE
-- Token : void*
-- Params : LPCSTR optional
-- VarName : LPCSTR
-- Value : LPSTR out
-- Size : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymGetSourceVarFromToken = lib.func('__stdcall', 'SymGetSourceVarFromToken', 'int32_t', ['void *', 'void *', 'str', 'str', 'char *', 'uint32_t']);
// SymGetSourceVarFromToken(hProcess, Token, Params, VarName, Value, Size)
// hProcess : HANDLE -> 'void *'
// Token : void* -> 'void *'
// Params : LPCSTR optional -> 'str'
// VarName : LPCSTR -> 'str'
// Value : LPSTR out -> 'char *'
// Size : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymGetSourceVarFromToken: { parameters: ["pointer", "pointer", "buffer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.SymGetSourceVarFromToken(hProcess, Token, Params, VarName, Value, Size)
// hProcess : HANDLE -> "pointer"
// Token : void* -> "pointer"
// Params : LPCSTR optional -> "buffer"
// VarName : LPCSTR -> "buffer"
// Value : LPSTR out -> "buffer"
// Size : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymGetSourceVarFromToken(
    void* hProcess,
    void* Token,
    const char* Params,
    const char* VarName,
    char* Value,
    uint32_t Size);
C, "dbghelp.dll");
// $ffi->SymGetSourceVarFromToken(hProcess, Token, Params, VarName, Value, Size);
// hProcess : HANDLE
// Token : void*
// Params : LPCSTR optional
// VarName : LPCSTR
// Value : LPSTR 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.ASCII_OPTIONS);
    boolean SymGetSourceVarFromToken(
        Pointer hProcess,   // HANDLE
        Pointer Token,   // void*
        String Params,   // LPCSTR optional
        String VarName,   // LPCSTR
        byte[] Value,   // LPSTR out
        int Size   // DWORD
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymGetSourceVarFromToken = SymGetSourceVarFromToken(
    hProcess : Void*,   # HANDLE
    Token : Void*,   # void*
    Params : UInt8*,   # LPCSTR optional
    VarName : UInt8*,   # LPCSTR
    Value : UInt8*,   # LPSTR 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 SymGetSourceVarFromTokenNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef SymGetSourceVarFromTokenDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int);
final SymGetSourceVarFromToken = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetSourceVarFromTokenNative, SymGetSourceVarFromTokenDart>('SymGetSourceVarFromToken');
// hProcess : HANDLE -> Pointer<Void>
// Token : void* -> Pointer<Void>
// Params : LPCSTR optional -> Pointer<Utf8>
// VarName : LPCSTR -> Pointer<Utf8>
// Value : LPSTR out -> Pointer<Utf8>
// Size : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymGetSourceVarFromToken(
  hProcess: THandle;   // HANDLE
  Token: Pointer;   // void*
  Params: PAnsiChar;   // LPCSTR optional
  VarName: PAnsiChar;   // LPCSTR
  Value: PAnsiChar;   // LPSTR out
  Size: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymGetSourceVarFromToken';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let symgetsourcevarfromtoken =
  foreign "SymGetSourceVarFromToken"
    ((ptr void) @-> (ptr void) @-> string @-> string @-> string @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Token : void* -> (ptr void) *)
(* Params : LPCSTR optional -> string *)
(* VarName : LPCSTR -> string *)
(* Value : LPSTR out -> string *)
(* 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 ("SymGetSourceVarFromToken" sym-get-source-var-from-token :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (token :pointer)   ; void*
  (params :string)   ; LPCSTR optional
  (var-name :string)   ; LPCSTR
  (value :pointer)   ; LPSTR out
  (size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetSourceVarFromToken = Win32::API::More->new('dbghelp',
    'BOOL SymGetSourceVarFromToken(HANDLE hProcess, LPVOID Token, LPCSTR Params, LPCSTR VarName, LPSTR Value, DWORD Size)');
# my $ret = $SymGetSourceVarFromToken->Call($hProcess, $Token, $Params, $VarName, $Value, $Size);
# hProcess : HANDLE -> HANDLE
# Token : void* -> LPVOID
# Params : LPCSTR optional -> LPCSTR
# VarName : LPCSTR -> LPCSTR
# Value : LPSTR out -> LPSTR
# Size : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い