diff --git a/docs/xml/lcl/lclproc.xml b/docs/xml/lcl/lclproc.xml index 530963ec12..bcab39271b 100644 --- a/docs/xml/lcl/lclproc.xml +++ b/docs/xml/lcl/lclproc.xml @@ -1028,97 +1028,106 @@ See ComparePoints. + + -Raises a catchable exception. + +Deprecated. Use LazTracer.RaiseGDBException instead. +

+Raises a catchable exception. +

+

Normally, GDB does not catch FPC Exception objects. This procedure raises a standard divide by zero exception which is caught by GDB.

+

+Calls the RaiseGDBException routine in LazTracer. +

 - - + +Deprecated in LCL version 3.99 (Apr 2024). + + +LazTracer.RaiseGDBException + - + +Message for the catchable exception. + -Writes a number of strings (heavily overloaded) to the debug output. +Deprecated. Use DebugLogger.DebugLn instead. - - + +

+Overloaded routine used to write a number of strings to the debug output. +

+

+Calls the DebugLn method in the DebugLogger unit property implemented in +LazLoggerBase.pas (LazUtils). +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +TLazLogger.DebugLn + -A single string, or a Format string when followed by an argument list. + +A single string, or a Format string when followed by an argument list. -Writes the formatted dump of the typed arguments. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +Writes the formatted dump of the typed arguments. + + + + + + + + + + + + + + + + + -Optionally writes a value to the debugger and increases the indentation level. +Deprecated. Use Use DebugLogger.DebugLnEnter instead. - - - - - - - - + +

+Overloaded routine used to write the specified argument values to the debugger. +Increases the indentation level for subsequent debugger output. +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +TLazLogger.DebugLnEnter +TLazLogger.DebugLnExit + + + @@ -1140,19 +1149,25 @@ Optionally writes a value to the debugger and increases the indentation level. -Optionally writes a value to the debugger and decreases the indentation level. +Deprecated. Use Use DebugLogger.DebugLnExit instead. - - - - - - - - - - + +

+Overloaded routine used to write the specified argument values to the debugger. +Decreases the indentation level for subsequent debugger output. +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +TLazLogger.DebugLnEnter +TLazLogger.DebugLnExit + + + @@ -1174,18 +1189,27 @@ Optionally writes a value to the debugger and decreases the indentation level. -Signals the OnDbgOut event handler for the debug logger class instance. +Deprecated. Use DebugLogger.DbgOut instead. - - - - - - - - - + +

+Signals the OnDbgOut event handler for the debug logger class instance. +

+

+Calls the DbgOut method in the DebugLogger unit property implemented in +LazLoggerBase.pas (LazUtils). +

+ + +Deprecated in LCL version 3.99 (Apr 204). + + + +TLazLogger.DbgOut + + + @@ -1199,189 +1223,225 @@ Signals the OnDbgOut event handler for the debug logger class instance. + -Formats debug output for various argument types (overloaded). + +Formats debug output for various argument types (overloaded). + -
    -
  • boolean: "True" or "False".
    • -
  • pointer: hexadecimal address.
    • -
  • TRect, TPoint: shows the x/y coordinates.
    • -
  • TComponentState: set.
    • -
  • TObject: Name:ClassName.
    • -
  • TClass: ClassName.
    • -
  • -String, WideString: chars > #126 are translated into #nn (or #nnnn) -character constants. -
    • -
+
+
TTextMetric
+
+Generates a delimited list of member names and values for the text metric. For +example: 'tmHeight: 16 tmAscent: 2 tmDescent: 2 ...'. +
+
TScrollInfo
+
+Generates a delimited list of member names and values for the scroll +information. For example: 'Pos: 2 Min: 1 Max: 10 Page: 1 TrackPos: 2' or +'(no scrollinfo)'. +
+
Variant
+
+Returns the string representation for the variant value. Returns +'<empty>' or '<null>' for variants with the varEmpty or varNull +types (respectively). +
+
+ +Other overloaded variants of DbgS have been deprecated in LCL version 3.99 (as +of Apr 2024). Use the DbgS routine from LazLoggerIntf (lazloggerbase, +lazloggerfile, lazloggerdummy) for these variants instead. + - + +LazLoggerBase.DbgS + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +String with the content representing the specified argument. + - + +TTextMetric instance with member values stored in the result. + - + +TScrollInfo instance with member values stored in the result. + + + +TVarData instance with member values stored in the result. + + + + + + + + + + + + + + + + + + + -Returns the component or class name. - - - - - - - - + +Deprecated. Use DbgSName from LazLoggerIntf instead. + + +

+Returns the component or class name. +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +LazLoggerBase.DbgSName + + + -Converts control characters, or characters above #126 into #hex format. +Deprecated. Use DebugLogger.DbgStr instead. - - - - - - - - + +

+Converts control characters, or characters above #126 into #hex format. +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +LazLoggerBase.DbgStr + + + -Converts control characters, or characters above #126 into #hex format. +Deprecated. Use DbgWideStr from LazLoggerIntf instead. - - - - - - - - + +

+Converts control characters, or characters above #126 into #hex format. +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +LazLoggerBase.DbgWideStr + + + -Provides an hex dump of a memory section. + +Deprecated. Use DbgMemRange from LazLoggerIntf instead. - - - - -The formatted dump. - - -The start address. - - -The number of bytes to dump. - - -The number of bytes per line, zero for no line breaks. + +

+Provides an dump of a memory region in hexadecimal format. +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +LazLoggerBase.DbgMemRange + + + + + -Provides a hex dump of an memory stream. - - + +Deprecated. Use dbgMemStream from LazLoggerIntf instead. + + +

+Provides a hex dump of an memory stream. +

The dump starts at the current stream position, the position moves to the end of the dumped range.

- - - - - - - - - - -The maximum number of bytes to dump. + + +Deprecated in LCL version 3.99 (Apr 2024). + + + +LazLoggerBase.DbgMemStream + + + + -Provides an hex dump of an TObject. - - - - - - - - - - + +Deprecated. Use DbgObjMem from LazLoggerIntf instead. + + +

+Provides an hex dump of an TObject. +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +LazLoggerBase.DbgObjMem + + + -Provides a hex dump of an Int64 value, (sign + absolute value). - - - - - - - - - - + +Deprecated. Use DbgHex from LazLoggerIntf instead. + + +

+Provides a hex dump of an Int64 value, (sign + absolute value). +

+ + +Deprecated in LCL version 3.99 (Apr 2024). + + + +LazLoggerBase.DbgHex + + + Provides a dump of SetWindowPosition flags. @@ -1475,11 +1535,21 @@ includes the thread identifier. -Calls the Finish method for the debug logger class instance. - - - - + +Deprecated. Use DebugLogger.Finish instead. + + +

+Calls the Finish method for the debug logger class instance. +

+ + +Deprecated in LCL version 3.99 (Apr 204). + + + +TLazLogger.Finish +