Root > Reference > All Functions > LocationToStr

Function LocationToStr

Previous pageReturn to chapter overviewNext page   

Converts location information to single line string.

 

Unit

EDebugInfo

 

Syntax

 

Code (Delphi)

function LocationToStr(

const AInfo: TELLocationInfo;

const AIncludeModuleName: Boolean = True;

const AIncludeAddressOffset: Boolean = True;

const AIncludeStartProcLineOffset: Boolean = False;

const AIncludeVAddress: Boolean = True;

const AIncludePointer: Boolean = True;

const AIncludeLine: Boolean = True;

const AUseParent: TELUseParent = eupNone

): String;

 

Parameters

AInfo [in]

A location information to be converted to string. It can be retrieved from GetLocationInfo function.

 

AIncludeModuleName [in, optional]

Specifies if result should include module name.

 

AIncludeAddressOffset [in, optional]

Specifies if result should include offset from the routine.

 

AIncludeStartProcLineOffset [in, optional]

Specifies if result should include offset from the line.

 

AIncludeVAddress [in, optional]

Specifies if result should include offset from module.

 

AIncludePointer [in, optional]

Specifies if result should include RAW pointer.

 

AIncludeLine [in, optional]

Specifies if result should include line number.

 

AUseParent [in, optional]

Specifies if result should include information about parent or child units (for includes only).

 

Return value

A human-readable single line string.

 

Remarks

This function converts location information record into single string, which can be shown to user.

 

See also

__MODULE__ function
__UNIT__ function
__FILE__ function
__FUNCTION__ function
__LINE__ function



Send feedback... Build date: 2023-09-11
Last edited: 2023-09-11
PRIVACY STATEMENT
The documentation team uses the feedback submitted to improve the EurekaLog documentation. We do not use your e-mail address for any other purpose. We will remove your e-mail address from our system after the issue you are reporting has been resolved. While we are working to resolve this issue, we may send you an e-mail message to request more information about your feedback. After the issues have been addressed, we may send you an email message to let you know that your feedback has been addressed.


Permanent link to this article: https://www.eurekalog.com/help/eurekalog/topic_function_edebuginfo_locationtostr.php