ホーム › System.Diagnostics.Debug › SymSrvGetFileIndexInfo

SymSrvGetFileIndexInfo

関数

ファイルのインデックス情報を取得する。

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

シグネチャ

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

BOOL SymSrvGetFileIndexInfo(
    LPCSTR File,
    SYMSRV_INDEX_INFO* Info,
    DWORD Flags
);

パラメーター

名前	型	方向	説明
File	LPCSTR	in	ファイルの名前。
Info	SYMSRV_INDEX_INFO*	out	インデックス情報を受け取る SYMSRV_INDEX_INFO 構造体。
Flags	DWORD	in	このパラメーターは将来の使用のために予約されています。

戻り値の型: BOOL

公式ドキュメント

SymSrvGetFileIndexInfo 関数 (dbghelp.h) は、指定された .pdb、.dbg、またはイメージファイルのインデックス情報を取得します。

戻り値

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

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

解説(Remarks)

この関数は一般的な使用を目的としたものではありません。シンボルサーバーストア内のファイルを管理するユーティリティを作成する場合、この関数を使用して、シンボルサーバーがファイルを検索する相対パスを予測できます。この関数は、実際にシンボルサーバーストアを設定するために srctool.exe で使用されます。また、SymFindFileInPath 関数に渡すパラメーターを見つけたい場合にも役立つことがあります。

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

BOOL SymSrvGetFileIndexInfo(
    LPCSTR File,
    SYMSRV_INDEX_INFO* Info,
    DWORD Flags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymSrvGetFileIndexInfo(
    [MarshalAs(UnmanagedType.LPStr)] string File,   // LPCSTR
    IntPtr Info,   // SYMSRV_INDEX_INFO* out
    uint Flags   // DWORD
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSrvGetFileIndexInfo(
    <MarshalAs(UnmanagedType.LPStr)> File As String,   ' LPCSTR
    Info As IntPtr,   ' SYMSRV_INDEX_INFO* out
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' File : LPCSTR
' Info : SYMSRV_INDEX_INFO* out
' Flags : DWORD
Declare PtrSafe Function SymSrvGetFileIndexInfo Lib "dbghelp" ( _
    ByVal File As String, _
    ByVal Info As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymSrvGetFileIndexInfo = ctypes.windll.dbghelp.SymSrvGetFileIndexInfo
SymSrvGetFileIndexInfo.restype = wintypes.BOOL
SymSrvGetFileIndexInfo.argtypes = [
    wintypes.LPCSTR,  # File : LPCSTR
    ctypes.c_void_p,  # Info : SYMSRV_INDEX_INFO* 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')
SymSrvGetFileIndexInfo = Fiddle::Function.new(
  lib['SymSrvGetFileIndexInfo'],
  [
    Fiddle::TYPE_VOIDP,  # File : LPCSTR
    Fiddle::TYPE_VOIDP,  # Info : SYMSRV_INDEX_INFO* out
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymSrvGetFileIndexInfo(
        File: *const u8,  // LPCSTR
        Info: *mut SYMSRV_INDEX_INFO,  // SYMSRV_INDEX_INFO* 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.Ansi, SetLastError = true)]
public static extern bool SymSrvGetFileIndexInfo([MarshalAs(UnmanagedType.LPStr)] string File, IntPtr Info, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSrvGetFileIndexInfo' -Namespace Win32 -PassThru
# $api::SymSrvGetFileIndexInfo(File, Info, Flags)

#uselib "dbghelp.dll"
#func global SymSrvGetFileIndexInfo "SymSrvGetFileIndexInfo" sptr, sptr, sptr
; SymSrvGetFileIndexInfo File, varptr(Info), Flags   ; 戻り値は stat
; File : LPCSTR -> "sptr"
; Info : SYMSRV_INDEX_INFO* out -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymSrvGetFileIndexInfo "SymSrvGetFileIndexInfo" str, var, int
; res = SymSrvGetFileIndexInfo(File, Info, Flags)
; File : LPCSTR -> "str"
; Info : SYMSRV_INDEX_INFO* out -> "var"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global SymSrvGetFileIndexInfo "SymSrvGetFileIndexInfo" str, sptr, int
; res = SymSrvGetFileIndexInfo(File, varptr(Info), Flags)
; File : LPCSTR -> "str"
; Info : SYMSRV_INDEX_INFO* out -> "sptr"
; Flags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。