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

SymSrvStoreSupplement

関数
シンボルサーバーに補足ファイルを格納する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

LPSTR SymSrvStoreSupplement(
    HANDLE hProcess,
    LPCSTR SrvPath,   // optional
    LPCSTR Node,
    LPCSTR File,
    DWORD Flags
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
SrvPathLPCSTRinoptionalシンボルストアへのパス。
NodeLPCSTRinサプリメンタルファイルに関連付けられたシンボルファイル。
FileLPCSTRinファイルの名前。
FlagsDWORDinこのパラメーターが SYMSTOREOPT_COMPRESS の場合、ファイルはシンボルストア内で圧縮されます。現在のところ、他にサポートされる値はありません。

戻り値の型: LPSTR

公式ドキュメント

SymSrvStoreSupplement 関数 (dbghelp.h) は、シンボルストアの指定したサプリメントにファイルを格納します。

戻り値

関数が成功した場合、戻り値はサプリメンタルファイルの完全修飾パスです。

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

解説(Remarks)

この関数の重要な用途の一つは、デルタファイルを格納することです。詳細については、SymSrvDeltaName を参照してください。

この関数は、別の関数によって再利用される可能性のあるバッファーへのポインターを返します。そのため、返されたデータは直ちに別のバッファーにコピーしてください。

シンボルサーバーは、同じ拡張子を持つサプリメンタルファイルを共通のディレクトリに格納します。たとえば、Sup1.xml は次のディレクトリに格納されます: SymPath\supplement\Node\xml。

ストアの管理者は、ストアのルートに Supplement という名前の読み取り専用ファイルを作成することで、ユーザーがサプリメンタルファイルを書き込めないようにできます。あるいは、管理者は supplement ディレクトリを作成し、ACL を使用してアクセスを制御することもできます。

この関数を含むすべての 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>

LPSTR SymSrvStoreSupplement(
    HANDLE hProcess,
    LPCSTR SrvPath,   // optional
    LPCSTR Node,
    LPCSTR File,
    DWORD Flags
);
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymSrvStoreSupplement(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string SrvPath,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string Node,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string File,   // LPCSTR
    uint Flags   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSrvStoreSupplement(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> SrvPath As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> Node As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> File As String,   ' LPCSTR
    Flags As UInteger   ' DWORD
) As IntPtr
End Function
' hProcess : HANDLE
' SrvPath : LPCSTR optional
' Node : LPCSTR
' File : LPCSTR
' Flags : DWORD
Declare PtrSafe Function SymSrvStoreSupplement Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal SrvPath As String, _
    ByVal Node As String, _
    ByVal File As String, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymSrvStoreSupplement = ctypes.windll.dbghelp.SymSrvStoreSupplement
SymSrvStoreSupplement.restype = wintypes.LPSTR
SymSrvStoreSupplement.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCSTR,  # SrvPath : LPCSTR optional
    wintypes.LPCSTR,  # Node : LPCSTR
    wintypes.LPCSTR,  # File : LPCSTR
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymSrvStoreSupplement = Fiddle::Function.new(
  lib['SymSrvStoreSupplement'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # SrvPath : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # Node : LPCSTR
    Fiddle::TYPE_VOIDP,  # File : LPCSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "dbghelp")]
extern "system" {
    fn SymSrvStoreSupplement(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        SrvPath: *const u8,  // LPCSTR optional
        Node: *const u8,  // LPCSTR
        File: *const u8,  // LPCSTR
        Flags: u32  // DWORD
    ) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr SymSrvStoreSupplement(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string SrvPath, [MarshalAs(UnmanagedType.LPStr)] string Node, [MarshalAs(UnmanagedType.LPStr)] string File, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSrvStoreSupplement' -Namespace Win32 -PassThru
# $api::SymSrvStoreSupplement(hProcess, SrvPath, Node, File, Flags)
#uselib "dbghelp.dll"
#func global SymSrvStoreSupplement "SymSrvStoreSupplement" sptr, sptr, sptr, sptr, sptr
; SymSrvStoreSupplement hProcess, SrvPath, Node, File, Flags   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; SrvPath : LPCSTR optional -> "sptr"
; Node : LPCSTR -> "sptr"
; File : LPCSTR -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymSrvStoreSupplement "SymSrvStoreSupplement" sptr, str, str, str, int
; res = SymSrvStoreSupplement(hProcess, SrvPath, Node, File, Flags)
; hProcess : HANDLE -> "sptr"
; SrvPath : LPCSTR optional -> "str"
; Node : LPCSTR -> "str"
; File : LPCSTR -> "str"
; Flags : DWORD -> "int"
; LPSTR SymSrvStoreSupplement(HANDLE hProcess, LPCSTR SrvPath, LPCSTR Node, LPCSTR File, DWORD Flags)
#uselib "dbghelp.dll"
#cfunc global SymSrvStoreSupplement "SymSrvStoreSupplement" intptr, str, str, str, int
; res = SymSrvStoreSupplement(hProcess, SrvPath, Node, File, Flags)
; hProcess : HANDLE -> "intptr"
; SrvPath : LPCSTR optional -> "str"
; Node : LPCSTR -> "str"
; File : LPCSTR -> "str"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSrvStoreSupplement = dbghelp.NewProc("SymSrvStoreSupplement")
)

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

extern "dbghelp" fn SymSrvStoreSupplement(
    hProcess: ?*anyopaque, // HANDLE
    SrvPath: [*c]const u8, // LPCSTR optional
    Node: [*c]const u8, // LPCSTR
    File: [*c]const u8, // LPCSTR
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) [*c]const u8;
proc SymSrvStoreSupplement(
    hProcess: pointer,  # HANDLE
    SrvPath: cstring,  # LPCSTR optional
    Node: cstring,  # LPCSTR
    File: cstring,  # LPCSTR
    Flags: uint32  # DWORD
): cstring {.importc: "SymSrvStoreSupplement", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
const(char)* SymSrvStoreSupplement(
    void* hProcess,   // HANDLE
    const(char)* SrvPath,   // LPCSTR optional
    const(char)* Node,   // LPCSTR
    const(char)* File,   // LPCSTR
    uint Flags   // DWORD
);
ccall((:SymSrvStoreSupplement, "dbghelp.dll"), stdcall, Cstring,
      (Ptr{Cvoid}, Cstring, Cstring, Cstring, UInt32),
      hProcess, SrvPath, Node, File, Flags)
# hProcess : HANDLE -> Ptr{Cvoid}
# SrvPath : LPCSTR optional -> Cstring
# Node : LPCSTR -> Cstring
# File : LPCSTR -> Cstring
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
const char* SymSrvStoreSupplement(
    void* hProcess,
    const char* SrvPath,
    const char* Node,
    const char* File,
    uint32_t Flags);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymSrvStoreSupplement(hProcess, SrvPath, Node, File, Flags)
-- hProcess : HANDLE
-- SrvPath : LPCSTR optional
-- Node : LPCSTR
-- File : LPCSTR
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymSrvStoreSupplement = lib.func('__stdcall', 'SymSrvStoreSupplement', 'void *', ['void *', 'str', 'str', 'str', 'uint32_t']);
// SymSrvStoreSupplement(hProcess, SrvPath, Node, File, Flags)
// hProcess : HANDLE -> 'void *'
// SrvPath : LPCSTR optional -> 'str'
// Node : LPCSTR -> 'str'
// File : LPCSTR -> 'str'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymSrvStoreSupplement: { parameters: ["pointer", "buffer", "buffer", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.SymSrvStoreSupplement(hProcess, SrvPath, Node, File, Flags)
// hProcess : HANDLE -> "pointer"
// SrvPath : LPCSTR optional -> "buffer"
// Node : LPCSTR -> "buffer"
// File : LPCSTR -> "buffer"
// Flags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const char* SymSrvStoreSupplement(
    void* hProcess,
    const char* SrvPath,
    const char* Node,
    const char* File,
    uint32_t Flags);
C, "dbghelp.dll");
// $ffi->SymSrvStoreSupplement(hProcess, SrvPath, Node, File, Flags);
// hProcess : HANDLE
// SrvPath : LPCSTR optional
// Node : LPCSTR
// File : LPCSTR
// Flags : 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);
    Pointer SymSrvStoreSupplement(
        Pointer hProcess,   // HANDLE
        String SrvPath,   // LPCSTR optional
        String Node,   // LPCSTR
        String File,   // LPCSTR
        int Flags   // DWORD
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymSrvStoreSupplement = SymSrvStoreSupplement(
    hProcess : Void*,   # HANDLE
    SrvPath : UInt8*,   # LPCSTR optional
    Node : UInt8*,   # LPCSTR
    File : UInt8*,   # LPCSTR
    Flags : UInt32   # DWORD
  ) : UInt8*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymSrvStoreSupplementNative = Pointer<Utf8> Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef SymSrvStoreSupplementDart = Pointer<Utf8> Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int);
final SymSrvStoreSupplement = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymSrvStoreSupplementNative, SymSrvStoreSupplementDart>('SymSrvStoreSupplement');
// hProcess : HANDLE -> Pointer<Void>
// SrvPath : LPCSTR optional -> Pointer<Utf8>
// Node : LPCSTR -> Pointer<Utf8>
// File : LPCSTR -> Pointer<Utf8>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymSrvStoreSupplement(
  hProcess: THandle;   // HANDLE
  SrvPath: PAnsiChar;   // LPCSTR optional
  Node: PAnsiChar;   // LPCSTR
  File: PAnsiChar;   // LPCSTR
  Flags: DWORD   // DWORD
): PAnsiChar; stdcall;
  external 'dbghelp.dll' name 'SymSrvStoreSupplement';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymSrvStoreSupplement"
  c_SymSrvStoreSupplement :: Ptr () -> CString -> CString -> CString -> Word32 -> IO CString
-- hProcess : HANDLE -> Ptr ()
-- SrvPath : LPCSTR optional -> CString
-- Node : LPCSTR -> CString
-- File : LPCSTR -> CString
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symsrvstoresupplement =
  foreign "SymSrvStoreSupplement"
    ((ptr void) @-> string @-> string @-> string @-> uint32_t @-> returning string)
(* hProcess : HANDLE -> (ptr void) *)
(* SrvPath : LPCSTR optional -> string *)
(* Node : LPCSTR -> string *)
(* File : LPCSTR -> string *)
(* Flags : 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 ("SymSrvStoreSupplement" sym-srv-store-supplement :convention :stdcall) :string
  (h-process :pointer)   ; HANDLE
  (srv-path :string)   ; LPCSTR optional
  (node :string)   ; LPCSTR
  (file :string)   ; LPCSTR
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSrvStoreSupplement = Win32::API::More->new('dbghelp',
    'LPSTR SymSrvStoreSupplement(HANDLE hProcess, LPCSTR SrvPath, LPCSTR Node, LPCSTR File, DWORD Flags)');
# my $ret = $SymSrvStoreSupplement->Call($hProcess, $SrvPath, $Node, $File, $Flags);
# hProcess : HANDLE -> HANDLE
# SrvPath : LPCSTR optional -> LPCSTR
# Node : LPCSTR -> LPCSTR
# File : LPCSTR -> LPCSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目