ホーム › System.Diagnostics.Debug › SymSrvGetFileIndexInfoW

SymSrvGetFileIndexInfoW

関数

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

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

シグネチャ

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

BOOL SymSrvGetFileIndexInfoW(
    LPCWSTR File,
    SYMSRV_INDEX_INFOW* Info,
    DWORD Flags
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SymSrvGetFileIndexInfoW(
    LPCWSTR File,
    SYMSRV_INDEX_INFOW* Info,
    DWORD Flags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymSrvGetFileIndexInfoW(
    [MarshalAs(UnmanagedType.LPWStr)] string File,   // LPCWSTR
    IntPtr Info,   // SYMSRV_INDEX_INFOW* out
    uint Flags   // DWORD
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSrvGetFileIndexInfoW(
    <MarshalAs(UnmanagedType.LPWStr)> File As String,   ' LPCWSTR
    Info As IntPtr,   ' SYMSRV_INDEX_INFOW* out
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' File : LPCWSTR
' Info : SYMSRV_INDEX_INFOW* out
' Flags : DWORD
Declare PtrSafe Function SymSrvGetFileIndexInfoW Lib "dbghelp" ( _
    ByVal File As LongPtr, _
    ByVal Info 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

SymSrvGetFileIndexInfoW = ctypes.windll.dbghelp.SymSrvGetFileIndexInfoW
SymSrvGetFileIndexInfoW.restype = wintypes.BOOL
SymSrvGetFileIndexInfoW.argtypes = [
    wintypes.LPCWSTR,  # File : LPCWSTR
    ctypes.c_void_p,  # Info : SYMSRV_INDEX_INFOW* 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')
SymSrvGetFileIndexInfoW = Fiddle::Function.new(
  lib['SymSrvGetFileIndexInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # File : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Info : SYMSRV_INDEX_INFOW* out
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dbghelp")]
extern "system" {
    fn SymSrvGetFileIndexInfoW(
        File: *const u16,  // LPCWSTR
        Info: *mut SYMSRV_INDEX_INFOW,  // SYMSRV_INDEX_INFOW* 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 SymSrvGetFileIndexInfoW([MarshalAs(UnmanagedType.LPWStr)] string File, IntPtr Info, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSrvGetFileIndexInfoW' -Namespace Win32 -PassThru
# $api::SymSrvGetFileIndexInfoW(File, Info, Flags)

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

出力引数:

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