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

SymGetFileLineOffsets64

関数
指定ソースファイルの各行のアドレスオフセットを取得する。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll
#include <windows.h>

DWORD SymGetFileLineOffsets64(
    HANDLE hProcess,
    LPCSTR ModuleName,   // optional
    LPCSTR FileName,
    ULONGLONG* Buffer,
    DWORD BufferLines
);

パラメーター

名前方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡したプロセスのハンドル。
ModuleNameLPCSTRinoptional行を検索する対象のモジュール名。このパラメーターが NULL の場合、関数はすべてのモジュールを検索します。
FileNameLPCSTRin行を検索する対象のファイル名。
BufferULONGLONG*out各行のオフセットの配列。行 n のオフセットは要素 n-1 に格納されます。行情報を持たない行に対応する配列要素は変更されません。
BufferLinesDWORDinBuffer 配列のサイズ(要素数)。

戻り値の型: DWORD

公式ドキュメント

指定したモジュールとファイル名の行情報を検索します。

戻り値

関数が成功した場合、戻り値は見つかった最大の行番号です。 行情報が見つからなかった場合、この値は 0 になります。

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

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// dbghelp.dll
#include <windows.h>

DWORD SymGetFileLineOffsets64(
    HANDLE hProcess,
    LPCSTR ModuleName,   // optional
    LPCSTR FileName,
    ULONGLONG* Buffer,
    DWORD BufferLines
);
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern uint SymGetFileLineOffsets64(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string ModuleName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    out ulong Buffer,   // ULONGLONG* out
    uint BufferLines   // DWORD
);
<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetFileLineOffsets64(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> ModuleName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    <Out> ByRef Buffer As ULong,   ' ULONGLONG* out
    BufferLines As UInteger   ' DWORD
) As UInteger
End Function
' hProcess : HANDLE
' ModuleName : LPCSTR optional
' FileName : LPCSTR
' Buffer : ULONGLONG* out
' BufferLines : DWORD
Declare PtrSafe Function SymGetFileLineOffsets64 Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal ModuleName As String, _
    ByVal FileName As String, _
    ByRef Buffer As LongLong, _
    ByVal BufferLines As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymGetFileLineOffsets64 = ctypes.windll.dbghelp.SymGetFileLineOffsets64
SymGetFileLineOffsets64.restype = wintypes.DWORD
SymGetFileLineOffsets64.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCSTR,  # ModuleName : LPCSTR optional
    wintypes.LPCSTR,  # FileName : LPCSTR
    ctypes.POINTER(ctypes.c_ulonglong),  # Buffer : ULONGLONG* out
    wintypes.DWORD,  # BufferLines : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetFileLineOffsets64 = Fiddle::Function.new(
  lib['SymGetFileLineOffsets64'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # ModuleName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # Buffer : ULONGLONG* out
    -Fiddle::TYPE_INT,  # BufferLines : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymGetFileLineOffsets64(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        ModuleName: *const u8,  // LPCSTR optional
        FileName: *const u8,  // LPCSTR
        Buffer: *mut u64,  // ULONGLONG* out
        BufferLines: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern uint SymGetFileLineOffsets64(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string ModuleName, [MarshalAs(UnmanagedType.LPStr)] string FileName, out ulong Buffer, uint BufferLines);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetFileLineOffsets64' -Namespace Win32 -PassThru
# $api::SymGetFileLineOffsets64(hProcess, ModuleName, FileName, Buffer, BufferLines)
#uselib "dbghelp.dll"
#func global SymGetFileLineOffsets64 "SymGetFileLineOffsets64" sptr, sptr, sptr, sptr, sptr
; SymGetFileLineOffsets64 hProcess, ModuleName, FileName, varptr(Buffer), BufferLines   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; ModuleName : LPCSTR optional -> "sptr"
; FileName : LPCSTR -> "sptr"
; Buffer : ULONGLONG* out -> "sptr"
; BufferLines : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymGetFileLineOffsets64 "SymGetFileLineOffsets64" sptr, str, str, var, int
; res = SymGetFileLineOffsets64(hProcess, ModuleName, FileName, Buffer, BufferLines)
; hProcess : HANDLE -> "sptr"
; ModuleName : LPCSTR optional -> "str"
; FileName : LPCSTR -> "str"
; Buffer : ULONGLONG* out -> "var"
; BufferLines : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD SymGetFileLineOffsets64(HANDLE hProcess, LPCSTR ModuleName, LPCSTR FileName, ULONGLONG* Buffer, DWORD BufferLines)
#uselib "dbghelp.dll"
#cfunc global SymGetFileLineOffsets64 "SymGetFileLineOffsets64" intptr, str, str, var, int
; res = SymGetFileLineOffsets64(hProcess, ModuleName, FileName, Buffer, BufferLines)
; hProcess : HANDLE -> "intptr"
; ModuleName : LPCSTR optional -> "str"
; FileName : LPCSTR -> "str"
; Buffer : ULONGLONG* out -> "var"
; BufferLines : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetFileLineOffsets64 = dbghelp.NewProc("SymGetFileLineOffsets64")
)

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

extern "dbghelp" fn SymGetFileLineOffsets64(
    hProcess: ?*anyopaque, // HANDLE
    ModuleName: [*c]const u8, // LPCSTR optional
    FileName: [*c]const u8, // LPCSTR
    Buffer: [*c]u64, // ULONGLONG* out
    BufferLines: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc SymGetFileLineOffsets64(
    hProcess: pointer,  # HANDLE
    ModuleName: cstring,  # LPCSTR optional
    FileName: cstring,  # LPCSTR
    Buffer: ptr uint64,  # ULONGLONG* out
    BufferLines: uint32  # DWORD
): uint32 {.importc: "SymGetFileLineOffsets64", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
uint SymGetFileLineOffsets64(
    void* hProcess,   // HANDLE
    const(char)* ModuleName,   // LPCSTR optional
    const(char)* FileName,   // LPCSTR
    ulong* Buffer,   // ULONGLONG* out
    uint BufferLines   // DWORD
);
ccall((:SymGetFileLineOffsets64, "dbghelp.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Cstring, Ptr{UInt64}, UInt32),
      hProcess, ModuleName, FileName, Buffer, BufferLines)
# hProcess : HANDLE -> Ptr{Cvoid}
# ModuleName : LPCSTR optional -> Cstring
# FileName : LPCSTR -> Cstring
# Buffer : ULONGLONG* out -> Ptr{UInt64}
# BufferLines : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SymGetFileLineOffsets64(
    void* hProcess,
    const char* ModuleName,
    const char* FileName,
    uint64_t* Buffer,
    uint32_t BufferLines);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymGetFileLineOffsets64(hProcess, ModuleName, FileName, Buffer, BufferLines)
-- hProcess : HANDLE
-- ModuleName : LPCSTR optional
-- FileName : LPCSTR
-- Buffer : ULONGLONG* out
-- BufferLines : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymGetFileLineOffsets64 = lib.func('__stdcall', 'SymGetFileLineOffsets64', 'uint32_t', ['void *', 'str', 'str', 'uint64_t *', 'uint32_t']);
// SymGetFileLineOffsets64(hProcess, ModuleName, FileName, Buffer, BufferLines)
// hProcess : HANDLE -> 'void *'
// ModuleName : LPCSTR optional -> 'str'
// FileName : LPCSTR -> 'str'
// Buffer : ULONGLONG* out -> 'uint64_t *'
// BufferLines : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymGetFileLineOffsets64: { parameters: ["pointer", "buffer", "buffer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.SymGetFileLineOffsets64(hProcess, ModuleName, FileName, Buffer, BufferLines)
// hProcess : HANDLE -> "pointer"
// ModuleName : LPCSTR optional -> "buffer"
// FileName : LPCSTR -> "buffer"
// Buffer : ULONGLONG* out -> "pointer"
// BufferLines : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SymGetFileLineOffsets64(
    void* hProcess,
    const char* ModuleName,
    const char* FileName,
    uint64_t* Buffer,
    uint32_t BufferLines);
C, "dbghelp.dll");
// $ffi->SymGetFileLineOffsets64(hProcess, ModuleName, FileName, Buffer, BufferLines);
// hProcess : HANDLE
// ModuleName : LPCSTR optional
// FileName : LPCSTR
// Buffer : ULONGLONG* out
// BufferLines : 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);
    int SymGetFileLineOffsets64(
        Pointer hProcess,   // HANDLE
        String ModuleName,   // LPCSTR optional
        String FileName,   // LPCSTR
        LongByReference Buffer,   // ULONGLONG* out
        int BufferLines   // DWORD
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymGetFileLineOffsets64 = SymGetFileLineOffsets64(
    hProcess : Void*,   # HANDLE
    ModuleName : UInt8*,   # LPCSTR optional
    FileName : UInt8*,   # LPCSTR
    Buffer : UInt64*,   # ULONGLONG* out
    BufferLines : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymGetFileLineOffsets64Native = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint64>, Uint32);
typedef SymGetFileLineOffsets64Dart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint64>, int);
final SymGetFileLineOffsets64 = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetFileLineOffsets64Native, SymGetFileLineOffsets64Dart>('SymGetFileLineOffsets64');
// hProcess : HANDLE -> Pointer<Void>
// ModuleName : LPCSTR optional -> Pointer<Utf8>
// FileName : LPCSTR -> Pointer<Utf8>
// Buffer : ULONGLONG* out -> Pointer<Uint64>
// BufferLines : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymGetFileLineOffsets64(
  hProcess: THandle;   // HANDLE
  ModuleName: PAnsiChar;   // LPCSTR optional
  FileName: PAnsiChar;   // LPCSTR
  Buffer: Pointer;   // ULONGLONG* out
  BufferLines: DWORD   // DWORD
): DWORD; stdcall;
  external 'dbghelp.dll' name 'SymGetFileLineOffsets64';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymGetFileLineOffsets64"
  c_SymGetFileLineOffsets64 :: Ptr () -> CString -> CString -> Ptr Word64 -> Word32 -> IO Word32
-- hProcess : HANDLE -> Ptr ()
-- ModuleName : LPCSTR optional -> CString
-- FileName : LPCSTR -> CString
-- Buffer : ULONGLONG* out -> Ptr Word64
-- BufferLines : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symgetfilelineoffsets64 =
  foreign "SymGetFileLineOffsets64"
    ((ptr void) @-> string @-> string @-> (ptr uint64_t) @-> uint32_t @-> returning uint32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* ModuleName : LPCSTR optional -> string *)
(* FileName : LPCSTR -> string *)
(* Buffer : ULONGLONG* out -> (ptr uint64_t) *)
(* BufferLines : 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 ("SymGetFileLineOffsets64" sym-get-file-line-offsets64 :convention :stdcall) :uint32
  (h-process :pointer)   ; HANDLE
  (module-name :string)   ; LPCSTR optional
  (file-name :string)   ; LPCSTR
  (buffer :pointer)   ; ULONGLONG* out
  (buffer-lines :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetFileLineOffsets64 = Win32::API::More->new('dbghelp',
    'DWORD SymGetFileLineOffsets64(HANDLE hProcess, LPCSTR ModuleName, LPCSTR FileName, LPVOID Buffer, DWORD BufferLines)');
# my $ret = $SymGetFileLineOffsets64->Call($hProcess, $ModuleName, $FileName, $Buffer, $BufferLines);
# hProcess : HANDLE -> HANDLE
# ModuleName : LPCSTR optional -> LPCSTR
# FileName : LPCSTR -> LPCSTR
# Buffer : ULONGLONG* out -> LPVOID
# BufferLines : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。