JCL Help:GetLocationInfoStr

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Returns location info in a formatted string, given an address.


Pascal

 function GetLocationInfoStr(const Addr: Pointer; IncludeModuleName: Boolean = False; IncludeAddressOffset: Boolean = False; IncludeStartProcLineOffset: Boolean = False; IncludeVAddress: Boolean = False): string;


Parameters

Parameters Description
const Addr: Pointer Address to obtain information on.
IncludeModuleName: Boolean = False Should the module name be included in the string. If this parameter is set to True, the module name is inserted right after the address.


Return Value

If location info was found, the function returns the formatted info string, otherwise it returns a string formatted as [Address].


Description

GetLocationInfoStr returns location info in a formatted string. The string is formatted as: [Address] UnitName.>ProcedureName (Line linenumber, "source file name" or [Address] {ModuleName} UnitName.ProcedureName (Line linenumber, "source file name", depending on the value of IncludeModuleName parameter.


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