From 4741e7df12a5a3ec9ba257a73b348a9ee156d65f Mon Sep 17 00:00:00 2001 From: dsiders Date: Sun, 23 Oct 2022 20:29:47 +0100 Subject: [PATCH] Docs: LazUtils/extendedstrings. Updates topic content and See Also links. Removes unused tags in private members. --- docs/xml/lazutils/extendedstrings.xml | 209 +++++++++++--------------- 1 file changed, 88 insertions(+), 121 deletions(-) diff --git a/docs/xml/lazutils/extendedstrings.xml b/docs/xml/lazutils/extendedstrings.xml index c24c79ef5e..c8df62cf57 100644 --- a/docs/xml/lazutils/extendedstrings.xml +++ b/docs/xml/lazutils/extendedstrings.xml @@ -48,16 +48,13 @@ type. - Memory allocated to a new record is cleared (filled with #0). - Objects call their free method before they are deleted. - Stores TExtStringsOption values. @@ -69,10 +66,11 @@ Stores TExtStringsOption values. the TExtendedStringList.Options property.

- + + + - Implements a string list that allows Records in its Objects property. @@ -83,7 +81,7 @@ Implements a string list that allows Records in its Objects property. provides support for using records in the class. The Records property allows access to records stored in the class. TExtendedStringList provides overridden methods to maintain values in the Objects -property. New properties and methods are included to control actions needed +property. New properties and methods are included to perform actions needed when adding or freeing Records stored in the Objects property.

@@ -92,77 +90,30 @@ when adding or freeing Records stored in the Objects property. - - - - - - - - + + + - - - - - - - - - - - - + + + - - - - - - - - + + - - - - - - - - - - - - + + + - - - - - - - - + + - - - - - - - - - - - - - - - - + + + + - + Changes the memory allocation size for the specified record. @@ -180,24 +131,19 @@ is changed. - Pointer to the record. - Ordinal position for the specified record. - Previous memory allocation size. - New memory allocation size. - Re-implements the read access specifier for the Objects property. @@ -215,21 +161,20 @@ GetObject and PutObject are called directly (as opposed to using the Objects property) in methods which maintain values in Records.

- + +TStringList + - TObject stored at the specified position. - Ordinal position for the requested value. - -Reimplements the write access specifier for Objects. +Reimplements the write access specifier for the Objects property.

@@ -245,61 +190,62 @@ GetObject and PutObject are called directly (as opposed to using the Objects property) in methods which maintain values in Records.

- + +TStringList + - Ordinal position for value. - Object to store at the specified position. - + Constructor for the class instance.

-Create is the constructor for the class instance. Create calls the -inherited constructor, and sets the default values in the following -properties: +Create is the overloaded constructor for the class instance. +Create calls the inherited constructor, and sets the default values +in the following properties:

Options
-
Set to [ esoClearRecordsOnCreate ]
+
Set to [ esoClearRecordsOnCreate ].
RecordSize
-
Set to the value in the InitialRecordSize argument
+
Set to the value in the InitialRecordSize argument.

Use RecordSize to change the memory allocation size for Records in the class.

- + +TStringList + - Memory size allocated for records. - Destructor for the class instance.

-Destroy is the destructor for the class instance. Destroy calls -FreeAllRecords to release memory allocated for entries in the Records -property. Destroy calls the inherited destructor. +Destroy is the overridden destructor for the class instance. +Destroy calls FreeAllRecords to release memory allocated for entries in the +Records property. Destroy calls the inherited destructor.

- + +TStringList.Destroy + - Removes items stored in the string list. @@ -311,10 +257,11 @@ the string list. Clear calls FreeAllRecords to release memory allocated for items in the Records property. Clear calls the inherited Clear method.

- + +TStringList.Clear + - Deletes the item at the specified position. @@ -327,14 +274,14 @@ in Records is freed by calling FreeRecord using the position in Index. Delete calls the inherited Delete method.

- + +TStringList.Delete + - Ordinal position for the item. - Allocates memory for a new record instance. @@ -353,14 +300,16 @@ CreateRecord is called when reading a value in the Records property, and when writing a value to the Objects property.

- + + + +TStrings.Objects + - Ordinal position for the record. - Frees memory allocated for the record at the specified position. @@ -380,14 +329,16 @@ FreeRecord is called when writing a new value in the Records property, and in methods like FreeAllRecords and Delete.

- + + + +TStrings.Objects + - Ordinal position for the record. - Frees memory allocated for all Records in the class. @@ -404,11 +355,12 @@ FreeAllRecords is called in the Clear method, and in the destructor for the class.

- - + + + + - Determines if memory has been allocated for the specified record. @@ -424,18 +376,17 @@ other than Nil. RecordAllocated is called when reading a value for the Records property.

- + + + - True if memory has been allocated for the record. - Ordinal position for the record. - Provides indexed access to records in the string list. @@ -457,14 +408,19 @@ calling FreeRecord. The inherited PutObject method is called to store the value in AValue as a TObject reference in the Objects property.

- + + + + + + +TStrings.Objects + - Ordinal position for the record. - Memory allocation size for Records in the class. @@ -477,11 +433,18 @@ is set to the argument passed in the constructor. Setting a new value for the property causes the allocated memory size for any existing Records to be changed to the new value.

+

+RecordSize is used in the CreateRecord method and indicates the initial size +for the block of memory allocated for the record instance using GetMem. +

- + + + + + - Contains record options enabled in the class. @@ -508,10 +471,14 @@ as set in the constructor for the class.

+ + + +