JCL Help:InsertDebugDataIntoExecutableFile@TFileName@TFileName@string@Integer@Integer

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Insert binary debug data into an executable.


Pascal

 function InsertDebugDataIntoExecutableFile(const ExecutableFileName: TFileName; const MapFileName: TFileName; out LinkerBugUnit: string; out MapFileSize: Integer; out JclDebugDataSize: Integer): Boolean; overload;
function InsertDebugDataIntoExecutableFile(const ExecutableFileName: TFileName; const MapFileName: TFileName; out LinkerBugUnit: string; out MapFileSize: Integer; out JclDebugDataSize: Integer; out LineNumberErrors: Integer): Boolean; overload;
function InsertDebugDataIntoExecutableFile(const ExecutableFileName: TFileName; BinDebug: TJclBinDebugGenerator; out LinkerBugUnit: string; out MapFileSize: Integer; out JclDebugDataSize: Integer): Boolean; overload;
function InsertDebugDataIntoExecutableFile(const ExecutableFileName: TFileName; BinDebug: TJclBinDebugGenerator; out LinkerBugUnit: string; out MapFileSize: Integer; out JclDebugDataSize: Integer; out LineNumberErrors: Integer): Boolean; overload;


Parameters

Parameters Description
const ExecutableFileName: TFileName File name of executable you want the debug data to be inserted in.
const MapFileName: TFileName Name of the map file to convert to binary debug data.
out LinkerBugUnit: string Variable where the name of the unit where the linker bug was first encountered should be stored. If there was no linker bug present, this variable will be set to empty.
out MapFileSize: Integer Variable where the size of the linker map file will be stored.
out JclDebugDataSize: Integer Variable where the size of the binary debug data will be stored.
BinDebug: TJclBinDebugGenerator The binary debug data generator.


Return Value

If the binary debug data was succesfully inserted into the executable the function returns True, otherwise it returns False. In addition to the function result, it will also return the unit for the linker bug (if any found), the map file size and the binary debug data size.


Description

InsertDebugDataIntoExecutableFile inserts binary debug data as a resource into the executable. With the first overloaded method you can specify a linker map file while the second overloaded method allow you to specify a binary debug generator. When the insertion succeeded True will be returned, otherwise False is returned.


About

Unit

JclDebug


Donator

Petr Vones


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page