ホーム › System.Diagnostics.Debug › SymAddSourceStreamA

SymAddSourceStreamA

関数

モジュールにソースストリームを追加する(ANSI版)。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

BOOL SymAddSourceStreamA(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR StreamFile,   // optional
    BYTE* Buffer,   // optional
    UINT_PTR Size
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
Base	ULONGLONG	in	モジュールのベースアドレス。
StreamFile	LPCSTR	inoptional	ソースインデックスストリームを格納するファイルへの絶対パスまたは相対パスを含む、NULL で終わる文字列。Buffer が NULL でない場合は NULL にできます。
Buffer	BYTE*	inoptional	ソースインデックスストリームを格納するバッファー。StreamFile が NULL でない場合は NULL にできます。
Size	UINT_PTR	in	Buffer バッファーのサイズ(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

指定したモジュールに、Source Server で使用するためのストリームを追加します。(SymAddSourceStreamA)

戻り値

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

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

解説(Remarks)

SymAddSourceStream は、Source Server で使用するために整形されたデータのストリームを、指定したモジュールに追加します。呼び出し元は、ストリームを Buffer パラメーターでバッファーとして渡すか、StreamFile パラメーターでファイルとして渡すことができます。両方のパラメーターが指定されている場合、関数は Buffer パラメーターを使用します。両方のパラメーターが NULL の場合、関数は FALSE を返し、最終エラーコードは ERROR_INVALID_PARAMETER に設定されます。

SymAddSourceStream は、データを永続化するために対応する PDB にストリームを追加するわけではない点に注意してください。この関数は、PDB が利用できないシナリオで独自のデバッガーをプログラムによって実装する場合に使用されます。

メモ

dbghelp.h ヘッダーは、SymAddSourceStream を、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  (ANSI / -A)
#include <windows.h>

BOOL SymAddSourceStreamA(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR StreamFile,   // optional
    BYTE* Buffer,   // optional
    UINT_PTR Size
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SymAddSourceStreamA(
    IntPtr hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPStr)] string StreamFile,   // LPCSTR optional
    IntPtr Buffer,   // BYTE* optional
    UIntPtr Size   // UINT_PTR
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SymAddSourceStreamA(
    hProcess As IntPtr,   ' HANDLE
    Base As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPStr)> StreamFile As String,   ' LPCSTR optional
    Buffer As IntPtr,   ' BYTE* optional
    Size As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' Base : ULONGLONG
' StreamFile : LPCSTR optional
' Buffer : BYTE* optional
' Size : UINT_PTR
Declare PtrSafe Function SymAddSourceStreamA Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Base As LongLong, _
    ByVal StreamFile As String, _
    ByVal Buffer As LongPtr, _
    ByVal Size As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymAddSourceStreamA = ctypes.windll.dbghelp.SymAddSourceStreamA
SymAddSourceStreamA.restype = wintypes.BOOL
SymAddSourceStreamA.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    wintypes.LPCSTR,  # StreamFile : LPCSTR optional
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional
    ctypes.c_size_t,  # Size : UINT_PTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymAddSourceStreamA = Fiddle::Function.new(
  lib['SymAddSourceStreamA'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Base : ULONGLONG
    Fiddle::TYPE_VOIDP,  # StreamFile : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional
    Fiddle::TYPE_UINTPTR_T,  # Size : UINT_PTR
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymAddSourceStreamA(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Base: u64,  // ULONGLONG
        StreamFile: *const u8,  // LPCSTR optional
        Buffer: *mut u8,  // BYTE* optional
        Size: usize  // UINT_PTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi)]
public static extern bool SymAddSourceStreamA(IntPtr hProcess, ulong Base, [MarshalAs(UnmanagedType.LPStr)] string StreamFile, IntPtr Buffer, UIntPtr Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymAddSourceStreamA' -Namespace Win32 -PassThru
# $api::SymAddSourceStreamA(hProcess, Base, StreamFile, Buffer, Size)

#uselib "dbghelp.dll"
#func global SymAddSourceStreamA "SymAddSourceStreamA" sptr, sptr, sptr, sptr, sptr
; SymAddSourceStreamA hProcess, Base, StreamFile, varptr(Buffer), Size   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "sptr"
; StreamFile : LPCSTR optional -> "sptr"
; Buffer : BYTE* optional -> "sptr"
; Size : UINT_PTR -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymAddSourceStreamA "SymAddSourceStreamA" sptr, int64, str, var, sptr
; res = SymAddSourceStreamA(hProcess, Base, StreamFile, Buffer, Size)
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; StreamFile : LPCSTR optional -> "str"
; Buffer : BYTE* optional -> "var"
; Size : UINT_PTR -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "dbghelp.dll"
#cfunc global SymAddSourceStreamA "SymAddSourceStreamA" sptr, int64, str, sptr, sptr
; res = SymAddSourceStreamA(hProcess, Base, StreamFile, varptr(Buffer), Size)
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; StreamFile : LPCSTR optional -> "str"
; Buffer : BYTE* optional -> "sptr"
; Size : UINT_PTR -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。