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

SymSrvStoreFileW

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

シグネチャ

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

LPWSTR SymSrvStoreFileW(
    HANDLE hProcess,
    LPCWSTR SrvPath,   // optional
    LPCWSTR File,
    SYM_SRV_STORE_FILE_FLAGS Flags
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
SrvPathLPCWSTRinoptionalシンボルストア。
FileLPCWSTRinファイルの名前。
FlagsSYM_SRV_STORE_FILE_FLAGSin

関数の動作を制御するフラグ。 このパラメーターには、次のいずれかの値を指定できます。

意味
SYMSTOREOPT_COMPRESS
0x01
ファイルを圧縮します。
SYMSTOREOPT_OVERWRITE
0x02
ファイルが既に存在する場合は上書きします。
SYMSTOREOPT_PASS_IF_EXISTS
0x40
ファイルがシンボルストアに既に存在する場合でもエラーを報告しません。
SYMSTOREOPT_POINTER
0x08
File.ptr に格納します。
SYMSTOREOPT_RETURNINDEX
0x04
インデックスのみを返します。

戻り値の型: LPWSTR

公式ドキュメント

SymSrvStoreFileW (Unicode) 関数 (dbghelp.h) は、指定したシンボルストアにファイルを格納します。

戻り値

関数が成功した場合、戻り値は格納されたファイルへの完全修飾パスを指定する null 終端文字列へのポインターです。

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

解説(Remarks)

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

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

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

メモ

dbghelp.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI バージョンと Unicode バージョンを自動的に選択するエイリアスとして SymSrvStoreFile を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立ではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

LPWSTR SymSrvStoreFileW(
    HANDLE hProcess,
    LPCWSTR SrvPath,   // optional
    LPCWSTR File,
    SYM_SRV_STORE_FILE_FLAGS Flags
);
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymSrvStoreFileW(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string SrvPath,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string File,   // LPCWSTR
    uint Flags   // SYM_SRV_STORE_FILE_FLAGS
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSrvStoreFileW(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> SrvPath As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> File As String,   ' LPCWSTR
    Flags As UInteger   ' SYM_SRV_STORE_FILE_FLAGS
) As IntPtr
End Function
' hProcess : HANDLE
' SrvPath : LPCWSTR optional
' File : LPCWSTR
' Flags : SYM_SRV_STORE_FILE_FLAGS
Declare PtrSafe Function SymSrvStoreFileW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal SrvPath As LongPtr, _
    ByVal File As LongPtr, _
    ByVal Flags As Long) As LongPtr
' 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

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

lib = Fiddle.dlopen('dbghelp.dll')
SymSrvStoreFileW = Fiddle::Function.new(
  lib['SymSrvStoreFileW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # SrvPath : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # File : LPCWSTR
    -Fiddle::TYPE_INT,  # Flags : SYM_SRV_STORE_FILE_FLAGS
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymSrvStoreFileW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        SrvPath: *const u16,  // LPCWSTR optional
        File: *const u16,  // LPCWSTR
        Flags: u32  // SYM_SRV_STORE_FILE_FLAGS
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr SymSrvStoreFileW(IntPtr hProcess, [MarshalAs(UnmanagedType.LPWStr)] string SrvPath, [MarshalAs(UnmanagedType.LPWStr)] string File, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSrvStoreFileW' -Namespace Win32 -PassThru
# $api::SymSrvStoreFileW(hProcess, SrvPath, File, Flags)
#uselib "dbghelp.dll"
#func global SymSrvStoreFileW "SymSrvStoreFileW" wptr, wptr, wptr, wptr
; SymSrvStoreFileW hProcess, SrvPath, File, Flags   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; SrvPath : LPCWSTR optional -> "wptr"
; File : LPCWSTR -> "wptr"
; Flags : SYM_SRV_STORE_FILE_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymSrvStoreFileW "SymSrvStoreFileW" sptr, wstr, wstr, int
; res = SymSrvStoreFileW(hProcess, SrvPath, File, Flags)
; hProcess : HANDLE -> "sptr"
; SrvPath : LPCWSTR optional -> "wstr"
; File : LPCWSTR -> "wstr"
; Flags : SYM_SRV_STORE_FILE_FLAGS -> "int"
; LPWSTR SymSrvStoreFileW(HANDLE hProcess, LPCWSTR SrvPath, LPCWSTR File, SYM_SRV_STORE_FILE_FLAGS Flags)
#uselib "dbghelp.dll"
#cfunc global SymSrvStoreFileW "SymSrvStoreFileW" intptr, wstr, wstr, int
; res = SymSrvStoreFileW(hProcess, SrvPath, File, Flags)
; hProcess : HANDLE -> "intptr"
; SrvPath : LPCWSTR optional -> "wstr"
; File : LPCWSTR -> "wstr"
; Flags : SYM_SRV_STORE_FILE_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSrvStoreFileW = dbghelp.NewProc("SymSrvStoreFileW")
)

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

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

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

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

let symsrvstorefilew =
  foreign "SymSrvStoreFileW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning (ptr uint16_t))
(* hProcess : HANDLE -> (ptr void) *)
(* SrvPath : LPCWSTR optional -> (ptr uint16_t) *)
(* File : LPCWSTR -> (ptr uint16_t) *)
(* Flags : SYM_SRV_STORE_FILE_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymSrvStoreFileW" sym-srv-store-file-w :convention :stdcall) (:string :encoding :utf-16le)
  (h-process :pointer)   ; HANDLE
  (srv-path (:string :encoding :utf-16le))   ; LPCWSTR optional
  (file (:string :encoding :utf-16le))   ; LPCWSTR
  (flags :uint32))   ; SYM_SRV_STORE_FILE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSrvStoreFileW = Win32::API::More->new('dbghelp',
    'LPWSTR SymSrvStoreFileW(HANDLE hProcess, LPCWSTR SrvPath, LPCWSTR File, DWORD Flags)');
# my $ret = $SymSrvStoreFileW->Call($hProcess, $SrvPath, $File, $Flags);
# hProcess : HANDLE -> HANDLE
# SrvPath : LPCWSTR optional -> LPCWSTR
# File : LPCWSTR -> LPCWSTR
# Flags : SYM_SRV_STORE_FILE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

使用する型