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

SymAddSourceStreamW

関数
モジュールにソースストリームを追加する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymAddSourceStreamW(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCWSTR FileSpec,   // optional
    BYTE* Buffer,   // optional
    UINT_PTR Size
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

SymAddSourceStreamW (Unicode) 関数は、Source Server が使用するために、指定したモジュールにストリームを追加します。

戻り値

関数が成功した場合、戻り値は 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  (Unicode / -W)
#include <windows.h>

BOOL SymAddSourceStreamW(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCWSTR FileSpec,   // optional
    BYTE* Buffer,   // optional
    UINT_PTR Size
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymAddSourceStreamW(
    IntPtr hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPWStr)] string FileSpec,   // LPCWSTR optional
    IntPtr Buffer,   // BYTE* optional
    UIntPtr Size   // UINT_PTR
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymAddSourceStreamW(
    hProcess As IntPtr,   ' HANDLE
    Base As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPWStr)> FileSpec As String,   ' LPCWSTR optional
    Buffer As IntPtr,   ' BYTE* optional
    Size As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' Base : ULONGLONG
' FileSpec : LPCWSTR optional
' Buffer : BYTE* optional
' Size : UINT_PTR
Declare PtrSafe Function SymAddSourceStreamW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Base As LongLong, _
    ByVal FileSpec As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByVal Size 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

SymAddSourceStreamW = ctypes.windll.dbghelp.SymAddSourceStreamW
SymAddSourceStreamW.restype = wintypes.BOOL
SymAddSourceStreamW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    wintypes.LPCWSTR,  # FileSpec : LPCWSTR optional
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional
    ctypes.c_size_t,  # Size : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymAddSourceStreamW = Fiddle::Function.new(
  lib['SymAddSourceStreamW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Base : ULONGLONG
    Fiddle::TYPE_VOIDP,  # FileSpec : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional
    Fiddle::TYPE_UINTPTR_T,  # Size : UINT_PTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymAddSourceStreamW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Base: u64,  // ULONGLONG
        FileSpec: *const u16,  // LPCWSTR 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.Unicode, SetLastError = true)]
public static extern bool SymAddSourceStreamW(IntPtr hProcess, ulong Base, [MarshalAs(UnmanagedType.LPWStr)] string FileSpec, IntPtr Buffer, UIntPtr Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymAddSourceStreamW' -Namespace Win32 -PassThru
# $api::SymAddSourceStreamW(hProcess, Base, FileSpec, Buffer, Size)
#uselib "dbghelp.dll"
#func global SymAddSourceStreamW "SymAddSourceStreamW" wptr, wptr, wptr, wptr, wptr
; SymAddSourceStreamW hProcess, Base, FileSpec, varptr(Buffer), Size   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; Base : ULONGLONG -> "wptr"
; FileSpec : LPCWSTR optional -> "wptr"
; Buffer : BYTE* optional -> "wptr"
; Size : UINT_PTR -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymAddSourceStreamW "SymAddSourceStreamW" sptr, int64, wstr, var, sptr
; res = SymAddSourceStreamW(hProcess, Base, FileSpec, Buffer, Size)
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; FileSpec : LPCWSTR optional -> "wstr"
; Buffer : BYTE* optional -> "var"
; Size : UINT_PTR -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; BOOL SymAddSourceStreamW(HANDLE hProcess, ULONGLONG Base, LPCWSTR FileSpec, BYTE* Buffer, UINT_PTR Size)
#uselib "dbghelp.dll"
#cfunc global SymAddSourceStreamW "SymAddSourceStreamW" intptr, int64, wstr, var, intptr
; res = SymAddSourceStreamW(hProcess, Base, FileSpec, Buffer, Size)
; hProcess : HANDLE -> "intptr"
; Base : ULONGLONG -> "int64"
; FileSpec : LPCWSTR optional -> "wstr"
; Buffer : BYTE* optional -> "var"
; Size : UINT_PTR -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymAddSourceStreamW = dbghelp.NewProc("SymAddSourceStreamW")
)

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

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

typedef SymAddSourceStreamWNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Utf16>, Pointer<Uint8>, UintPtr);
typedef SymAddSourceStreamWDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Uint8>, int);
final SymAddSourceStreamW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymAddSourceStreamWNative, SymAddSourceStreamWDart>('SymAddSourceStreamW');
// hProcess : HANDLE -> Pointer<Void>
// Base : ULONGLONG -> Uint64
// FileSpec : LPCWSTR optional -> Pointer<Utf16>
// Buffer : BYTE* optional -> Pointer<Uint8>
// Size : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymAddSourceStreamW(
  hProcess: THandle;   // HANDLE
  Base: UInt64;   // ULONGLONG
  FileSpec: PWideChar;   // LPCWSTR optional
  Buffer: Pointer;   // BYTE* optional
  Size: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymAddSourceStreamW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymAddSourceStreamW"
  c_SymAddSourceStreamW :: Ptr () -> Word64 -> CWString -> Ptr Word8 -> CUIntPtr -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Base : ULONGLONG -> Word64
-- FileSpec : LPCWSTR optional -> CWString
-- Buffer : BYTE* optional -> Ptr Word8
-- Size : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symaddsourcestreamw =
  foreign "SymAddSourceStreamW"
    ((ptr void) @-> uint64_t @-> (ptr uint16_t) @-> (ptr uint8_t) @-> size_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Base : ULONGLONG -> uint64_t *)
(* FileSpec : LPCWSTR optional -> (ptr uint16_t) *)
(* Buffer : BYTE* optional -> (ptr uint8_t) *)
(* Size : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymAddSourceStreamW" sym-add-source-stream-w :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base :uint64)   ; ULONGLONG
  (file-spec (:string :encoding :utf-16le))   ; LPCWSTR optional
  (buffer :pointer)   ; BYTE* optional
  (size :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymAddSourceStreamW = Win32::API::More->new('dbghelp',
    'BOOL SymAddSourceStreamW(HANDLE hProcess, UINT64 Base, LPCWSTR FileSpec, LPVOID Buffer, WPARAM Size)');
# my $ret = $SymAddSourceStreamW->Call($hProcess, $Base, $FileSpec, $Buffer, $Size);
# hProcess : HANDLE -> HANDLE
# Base : ULONGLONG -> UINT64
# FileSpec : LPCWSTR optional -> LPCWSTR
# Buffer : BYTE* optional -> LPVOID
# Size : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い