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

SymSrvGetFileIndexString

関数
ファイルのインデックス文字列を取得する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymSrvGetFileIndexString(
    HANDLE hProcess,
    LPCSTR SrvPath,   // optional
    LPCSTR File,
    LPSTR Index,
    UINT_PTR Size,
    DWORD Flags
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
SrvPathLPCSTRinoptionalシンボルサーバーへのパス。
FileLPCSTRinファイルの名前。
IndexLPSTRoutインデックス文字列を受け取る バッファーへのポインター。
SizeUINT_PTRinIndex バッファーのサイズ(文字数単位)。
FlagsDWORDinこのパラメーターは将来の使用のために予約されています。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

この関数は一般的な用途向けではありません。シンボルサーバーストア内のファイルを管理するユーティリティを作成する場合、シンボルサーバーがファイルを探す相対パスを予測するためにこの関数を使用できます。この関数は、シンボルサーバーストアを実際に設定するために srctool.exe によって使用されます。

この関数を含むすべての 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 SymSrvGetFileIndexString(
    HANDLE hProcess,
    LPCSTR SrvPath,   // optional
    LPCSTR File,
    LPSTR Index,
    UINT_PTR Size,
    DWORD Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymSrvGetFileIndexString(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string SrvPath,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string File,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Index,   // LPSTR out
    UIntPtr Size,   // UINT_PTR
    uint Flags   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSrvGetFileIndexString(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> SrvPath As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> File As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> Index As System.Text.StringBuilder,   ' LPSTR out
    Size As UIntPtr,   ' UINT_PTR
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' SrvPath : LPCSTR optional
' File : LPCSTR
' Index : LPSTR out
' Size : UINT_PTR
' Flags : DWORD
Declare PtrSafe Function SymSrvGetFileIndexString Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal SrvPath As String, _
    ByVal File As String, _
    ByVal Index As String, _
    ByVal Size 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

SymSrvGetFileIndexString = ctypes.windll.dbghelp.SymSrvGetFileIndexString
SymSrvGetFileIndexString.restype = wintypes.BOOL
SymSrvGetFileIndexString.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCSTR,  # SrvPath : LPCSTR optional
    wintypes.LPCSTR,  # File : LPCSTR
    wintypes.LPSTR,  # Index : LPSTR out
    ctypes.c_size_t,  # Size : UINT_PTR
    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')
SymSrvGetFileIndexString = Fiddle::Function.new(
  lib['SymSrvGetFileIndexString'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # SrvPath : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # File : LPCSTR
    Fiddle::TYPE_VOIDP,  # Index : LPSTR out
    Fiddle::TYPE_UINTPTR_T,  # Size : UINT_PTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymSrvGetFileIndexString(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        SrvPath: *const u8,  // LPCSTR optional
        File: *const u8,  // LPCSTR
        Index: *mut u8,  // LPSTR out
        Size: usize,  // UINT_PTR
        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 SymSrvGetFileIndexString(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string SrvPath, [MarshalAs(UnmanagedType.LPStr)] string File, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Index, UIntPtr Size, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSrvGetFileIndexString' -Namespace Win32 -PassThru
# $api::SymSrvGetFileIndexString(hProcess, SrvPath, File, Index, Size, Flags)
#uselib "dbghelp.dll"
#func global SymSrvGetFileIndexString "SymSrvGetFileIndexString" sptr, sptr, sptr, sptr, sptr, sptr
; SymSrvGetFileIndexString hProcess, SrvPath, File, varptr(Index), Size, Flags   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; SrvPath : LPCSTR optional -> "sptr"
; File : LPCSTR -> "sptr"
; Index : LPSTR out -> "sptr"
; Size : UINT_PTR -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymSrvGetFileIndexString "SymSrvGetFileIndexString" sptr, str, str, var, sptr, int
; res = SymSrvGetFileIndexString(hProcess, SrvPath, File, Index, Size, Flags)
; hProcess : HANDLE -> "sptr"
; SrvPath : LPCSTR optional -> "str"
; File : LPCSTR -> "str"
; Index : LPSTR out -> "var"
; Size : UINT_PTR -> "sptr"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SymSrvGetFileIndexString(HANDLE hProcess, LPCSTR SrvPath, LPCSTR File, LPSTR Index, UINT_PTR Size, DWORD Flags)
#uselib "dbghelp.dll"
#cfunc global SymSrvGetFileIndexString "SymSrvGetFileIndexString" intptr, str, str, var, intptr, int
; res = SymSrvGetFileIndexString(hProcess, SrvPath, File, Index, Size, Flags)
; hProcess : HANDLE -> "intptr"
; SrvPath : LPCSTR optional -> "str"
; File : LPCSTR -> "str"
; Index : LPSTR out -> "var"
; Size : UINT_PTR -> "intptr"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSrvGetFileIndexString = dbghelp.NewProc("SymSrvGetFileIndexString")
)

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

extern "dbghelp" fn SymSrvGetFileIndexString(
    hProcess: ?*anyopaque, // HANDLE
    SrvPath: [*c]const u8, // LPCSTR optional
    File: [*c]const u8, // LPCSTR
    Index: [*c]u8, // LPSTR out
    Size: usize, // UINT_PTR
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SymSrvGetFileIndexString(
    hProcess: pointer,  # HANDLE
    SrvPath: cstring,  # LPCSTR optional
    File: cstring,  # LPCSTR
    Index: ptr char,  # LPSTR out
    Size: uint,  # UINT_PTR
    Flags: uint32  # DWORD
): int32 {.importc: "SymSrvGetFileIndexString", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymSrvGetFileIndexString(
    void* hProcess,   // HANDLE
    const(char)* SrvPath,   // LPCSTR optional
    const(char)* File,   // LPCSTR
    char* Index,   // LPSTR out
    size_t Size,   // UINT_PTR
    uint Flags   // DWORD
);
ccall((:SymSrvGetFileIndexString, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Cstring, Ptr{UInt8}, Csize_t, UInt32),
      hProcess, SrvPath, File, Index, Size, Flags)
# hProcess : HANDLE -> Ptr{Cvoid}
# SrvPath : LPCSTR optional -> Cstring
# File : LPCSTR -> Cstring
# Index : LPSTR out -> Ptr{UInt8}
# Size : UINT_PTR -> Csize_t
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymSrvGetFileIndexString(
    void* hProcess,
    const char* SrvPath,
    const char* File,
    char* Index,
    uintptr_t Size,
    uint32_t Flags);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymSrvGetFileIndexString(hProcess, SrvPath, File, Index, Size, Flags)
-- hProcess : HANDLE
-- SrvPath : LPCSTR optional
-- File : LPCSTR
-- Index : LPSTR out
-- Size : UINT_PTR
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymSrvGetFileIndexString = lib.func('__stdcall', 'SymSrvGetFileIndexString', 'int32_t', ['void *', 'str', 'str', 'char *', 'uintptr_t', 'uint32_t']);
// SymSrvGetFileIndexString(hProcess, SrvPath, File, Index, Size, Flags)
// hProcess : HANDLE -> 'void *'
// SrvPath : LPCSTR optional -> 'str'
// File : LPCSTR -> 'str'
// Index : LPSTR out -> 'char *'
// Size : UINT_PTR -> 'uintptr_t'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymSrvGetFileIndexString: { parameters: ["pointer", "buffer", "buffer", "buffer", "usize", "u32"], result: "i32" },
});
// lib.symbols.SymSrvGetFileIndexString(hProcess, SrvPath, File, Index, Size, Flags)
// hProcess : HANDLE -> "pointer"
// SrvPath : LPCSTR optional -> "buffer"
// File : LPCSTR -> "buffer"
// Index : LPSTR out -> "buffer"
// Size : UINT_PTR -> "usize"
// Flags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymSrvGetFileIndexString(
    void* hProcess,
    const char* SrvPath,
    const char* File,
    char* Index,
    size_t Size,
    uint32_t Flags);
C, "dbghelp.dll");
// $ffi->SymSrvGetFileIndexString(hProcess, SrvPath, File, Index, Size, Flags);
// hProcess : HANDLE
// SrvPath : LPCSTR optional
// File : LPCSTR
// Index : LPSTR out
// Size : UINT_PTR
// 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);
    boolean SymSrvGetFileIndexString(
        Pointer hProcess,   // HANDLE
        String SrvPath,   // LPCSTR optional
        String File,   // LPCSTR
        byte[] Index,   // LPSTR out
        long Size,   // UINT_PTR
        int Flags   // DWORD
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymSrvGetFileIndexString = SymSrvGetFileIndexString(
    hProcess : Void*,   # HANDLE
    SrvPath : UInt8*,   # LPCSTR optional
    File : UInt8*,   # LPCSTR
    Index : UInt8*,   # LPSTR out
    Size : LibC::SizeT,   # UINT_PTR
    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 SymSrvGetFileIndexStringNative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, UintPtr, Uint32);
typedef SymSrvGetFileIndexStringDart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, int);
final SymSrvGetFileIndexString = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymSrvGetFileIndexStringNative, SymSrvGetFileIndexStringDart>('SymSrvGetFileIndexString');
// hProcess : HANDLE -> Pointer<Void>
// SrvPath : LPCSTR optional -> Pointer<Utf8>
// File : LPCSTR -> Pointer<Utf8>
// Index : LPSTR out -> Pointer<Utf8>
// Size : UINT_PTR -> UintPtr
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymSrvGetFileIndexString(
  hProcess: THandle;   // HANDLE
  SrvPath: PAnsiChar;   // LPCSTR optional
  File: PAnsiChar;   // LPCSTR
  Index: PAnsiChar;   // LPSTR out
  Size: NativeUInt;   // UINT_PTR
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymSrvGetFileIndexString';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

文字セット違い