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

SymSrvGetFileIndexesW

関数
ファイルのシンボルサーバーインデックス値を取得する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymSrvGetFileIndexesW(
    LPCWSTR File,
    GUID* Id,
    DWORD* Val1,
    DWORD* Val2,   // optional
    DWORD Flags
);

パラメーター

名前方向説明
FileLPCWSTRinファイルの名前。
IdGUID*out3 つの識別パラメーターのうち 1 番目のパラメーター。
Val1DWORD*out3 つの識別パラメーターのうち 2 番目のパラメーター。
Val2DWORD*outoptional3 つの識別パラメーターのうち 3 番目のパラメーター。
FlagsDWORDinこのパラメーターは、将来の使用のために予約されています。

戻り値の型: BOOL

公式ドキュメント

SymSrvGetFileIndexesW (Unicode) 関数 (dbghelp.h) は、指定された .pdb、.dbg、またはイメージ ファイルを格納する際に使用されるインデックスを取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 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  (Unicode / -W)
#include <windows.h>

BOOL SymSrvGetFileIndexesW(
    LPCWSTR File,
    GUID* Id,
    DWORD* Val1,
    DWORD* Val2,   // optional
    DWORD Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymSrvGetFileIndexesW(
    [MarshalAs(UnmanagedType.LPWStr)] string File,   // LPCWSTR
    out Guid Id,   // GUID* out
    out uint Val1,   // DWORD* out
    IntPtr Val2,   // DWORD* optional, out
    uint Flags   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSrvGetFileIndexesW(
    <MarshalAs(UnmanagedType.LPWStr)> File As String,   ' LPCWSTR
    <Out> ByRef Id As Guid,   ' GUID* out
    <Out> ByRef Val1 As UInteger,   ' DWORD* out
    Val2 As IntPtr,   ' DWORD* optional, out
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' File : LPCWSTR
' Id : GUID* out
' Val1 : DWORD* out
' Val2 : DWORD* optional, out
' Flags : DWORD
Declare PtrSafe Function SymSrvGetFileIndexesW Lib "dbghelp" ( _
    ByVal File As LongPtr, _
    ByVal Id As LongPtr, _
    ByRef Val1 As Long, _
    ByVal Val2 As LongPtr, _
    ByVal Flags As Long) 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

SymSrvGetFileIndexesW = ctypes.windll.dbghelp.SymSrvGetFileIndexesW
SymSrvGetFileIndexesW.restype = wintypes.BOOL
SymSrvGetFileIndexesW.argtypes = [
    wintypes.LPCWSTR,  # File : LPCWSTR
    ctypes.c_void_p,  # Id : GUID* out
    ctypes.POINTER(wintypes.DWORD),  # Val1 : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # Val2 : DWORD* optional, out
    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')
SymSrvGetFileIndexesW = Fiddle::Function.new(
  lib['SymSrvGetFileIndexesW'],
  [
    Fiddle::TYPE_VOIDP,  # File : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Id : GUID* out
    Fiddle::TYPE_VOIDP,  # Val1 : DWORD* out
    Fiddle::TYPE_VOIDP,  # Val2 : DWORD* optional, out
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymSrvGetFileIndexesW(
        File: *const u16,  // LPCWSTR
        Id: *mut GUID,  // GUID* out
        Val1: *mut u32,  // DWORD* out
        Val2: *mut u32,  // DWORD* optional, out
        Flags: u32  // DWORD
    ) -> 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 SymSrvGetFileIndexesW([MarshalAs(UnmanagedType.LPWStr)] string File, out Guid Id, out uint Val1, IntPtr Val2, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSrvGetFileIndexesW' -Namespace Win32 -PassThru
# $api::SymSrvGetFileIndexesW(File, Id, Val1, Val2, Flags)
#uselib "dbghelp.dll"
#func global SymSrvGetFileIndexesW "SymSrvGetFileIndexesW" wptr, wptr, wptr, wptr, wptr
; SymSrvGetFileIndexesW File, varptr(Id), varptr(Val1), varptr(Val2), Flags   ; 戻り値は stat
; File : LPCWSTR -> "wptr"
; Id : GUID* out -> "wptr"
; Val1 : DWORD* out -> "wptr"
; Val2 : DWORD* optional, out -> "wptr"
; Flags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymSrvGetFileIndexesW "SymSrvGetFileIndexesW" wstr, var, var, var, int
; res = SymSrvGetFileIndexesW(File, Id, Val1, Val2, Flags)
; File : LPCWSTR -> "wstr"
; Id : GUID* out -> "var"
; Val1 : DWORD* out -> "var"
; Val2 : DWORD* optional, out -> "var"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SymSrvGetFileIndexesW(LPCWSTR File, GUID* Id, DWORD* Val1, DWORD* Val2, DWORD Flags)
#uselib "dbghelp.dll"
#cfunc global SymSrvGetFileIndexesW "SymSrvGetFileIndexesW" wstr, var, var, var, int
; res = SymSrvGetFileIndexesW(File, Id, Val1, Val2, Flags)
; File : LPCWSTR -> "wstr"
; Id : GUID* out -> "var"
; Val1 : DWORD* out -> "var"
; Val2 : DWORD* optional, out -> "var"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSrvGetFileIndexesW = dbghelp.NewProc("SymSrvGetFileIndexesW")
)

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

extern "dbghelp" fn SymSrvGetFileIndexesW(
    File: [*c]const u16, // LPCWSTR
    Id: [*c]GUID, // GUID* out
    Val1: [*c]u32, // DWORD* out
    Val2: [*c]u32, // DWORD* optional, out
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SymSrvGetFileIndexesW(
    File: WideCString,  # LPCWSTR
    Id: ptr GUID,  # GUID* out
    Val1: ptr uint32,  # DWORD* out
    Val2: ptr uint32,  # DWORD* optional, out
    Flags: uint32  # DWORD
): int32 {.importc: "SymSrvGetFileIndexesW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
int SymSrvGetFileIndexesW(
    const(wchar)* File,   // LPCWSTR
    GUID* Id,   // GUID* out
    uint* Val1,   // DWORD* out
    uint* Val2,   // DWORD* optional, out
    uint Flags   // DWORD
);
ccall((:SymSrvGetFileIndexesW, "dbghelp.dll"), stdcall, Int32,
      (Cwstring, Ptr{GUID}, Ptr{UInt32}, Ptr{UInt32}, UInt32),
      File, Id, Val1, Val2, Flags)
# File : LPCWSTR -> Cwstring
# Id : GUID* out -> Ptr{GUID}
# Val1 : DWORD* out -> Ptr{UInt32}
# Val2 : DWORD* optional, out -> Ptr{UInt32}
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymSrvGetFileIndexesW(
    const uint16_t* File,
    void* Id,
    uint32_t* Val1,
    uint32_t* Val2,
    uint32_t Flags);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymSrvGetFileIndexesW(File, Id, Val1, Val2, Flags)
-- File : LPCWSTR
-- Id : GUID* out
-- Val1 : DWORD* out
-- Val2 : DWORD* optional, out
-- Flags : DWORD
-- 構造体/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 SymSrvGetFileIndexesW = lib.func('__stdcall', 'SymSrvGetFileIndexesW', 'int32_t', ['str16', 'void *', 'uint32_t *', 'uint32_t *', 'uint32_t']);
// SymSrvGetFileIndexesW(File, Id, Val1, Val2, Flags)
// File : LPCWSTR -> 'str16'
// Id : GUID* out -> 'void *'
// Val1 : DWORD* out -> 'uint32_t *'
// Val2 : DWORD* optional, out -> 'uint32_t *'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymSrvGetFileIndexesW: { parameters: ["buffer", "pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SymSrvGetFileIndexesW(File, Id, Val1, Val2, Flags)
// File : LPCWSTR -> "buffer"
// Id : GUID* out -> "pointer"
// Val1 : DWORD* out -> "pointer"
// Val2 : DWORD* optional, out -> "pointer"
// Flags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymSrvGetFileIndexesW(
    const uint16_t* File,
    void* Id,
    uint32_t* Val1,
    uint32_t* Val2,
    uint32_t Flags);
C, "dbghelp.dll");
// $ffi->SymSrvGetFileIndexesW(File, Id, Val1, Val2, Flags);
// File : LPCWSTR
// Id : GUID* out
// Val1 : DWORD* out
// Val2 : DWORD* optional, out
// 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.UNICODE_OPTIONS);
    boolean SymSrvGetFileIndexesW(
        WString File,   // LPCWSTR
        Pointer Id,   // GUID* out
        IntByReference Val1,   // DWORD* out
        IntByReference Val2,   // DWORD* optional, out
        int Flags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun SymSrvGetFileIndexesW = SymSrvGetFileIndexesW(
    File : UInt16*,   # LPCWSTR
    Id : GUID*,   # GUID* out
    Val1 : UInt32*,   # DWORD* out
    Val2 : UInt32*,   # DWORD* optional, out
    Flags : 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 SymSrvGetFileIndexesWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Uint32);
typedef SymSrvGetFileIndexesWDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, int);
final SymSrvGetFileIndexesW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymSrvGetFileIndexesWNative, SymSrvGetFileIndexesWDart>('SymSrvGetFileIndexesW');
// File : LPCWSTR -> Pointer<Utf16>
// Id : GUID* out -> Pointer<Void>
// Val1 : DWORD* out -> Pointer<Uint32>
// Val2 : DWORD* optional, out -> Pointer<Uint32>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymSrvGetFileIndexesW(
  File: PWideChar;   // LPCWSTR
  Id: PGUID;   // GUID* out
  Val1: Pointer;   // DWORD* out
  Val2: Pointer;   // DWORD* optional, out
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymSrvGetFileIndexesW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymSrvGetFileIndexesW"
  c_SymSrvGetFileIndexesW :: CWString -> Ptr () -> Ptr Word32 -> Ptr Word32 -> Word32 -> IO CInt
-- File : LPCWSTR -> CWString
-- Id : GUID* out -> Ptr ()
-- Val1 : DWORD* out -> Ptr Word32
-- Val2 : DWORD* optional, out -> Ptr Word32
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symsrvgetfileindexesw =
  foreign "SymSrvGetFileIndexesW"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* File : LPCWSTR -> (ptr uint16_t) *)
(* Id : GUID* out -> (ptr void) *)
(* Val1 : DWORD* out -> (ptr uint32_t) *)
(* Val2 : DWORD* optional, out -> (ptr uint32_t) *)
(* 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 ("SymSrvGetFileIndexesW" sym-srv-get-file-indexes-w :convention :stdcall) :int32
  (file (:string :encoding :utf-16le))   ; LPCWSTR
  (id :pointer)   ; GUID* out
  (val1 :pointer)   ; DWORD* out
  (val2 :pointer)   ; DWORD* optional, out
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSrvGetFileIndexesW = Win32::API::More->new('dbghelp',
    'BOOL SymSrvGetFileIndexesW(LPCWSTR File, LPVOID Id, LPVOID Val1, LPVOID Val2, DWORD Flags)');
# my $ret = $SymSrvGetFileIndexesW->Call($File, $Id, $Val1, $Val2, $Flags);
# File : LPCWSTR -> LPCWSTR
# Id : GUID* out -> LPVOID
# Val1 : DWORD* out -> LPVOID
# Val2 : DWORD* optional, out -> LPVOID
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。