paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-23 07:59:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazUtils/stringhashlist. Removes extra spaces in topics.

Browse Source
This commit is contained in:
dsiders 2022-06-12 23:59:51 +01:00
parent 01adaa2ebb
commit 787a34a7e2
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/xml/lazutils/stringhashlist.xml
View File

@ -77,7 +77,7 @@
<short>Implements a container used to store hashed item values, keys, and data.</short>
<descr>
<p>
<var>TStringHashList</var> is a <var>TObject</var> descendant which implements a container for hash values, keys, and data for <var>String</var> types.
<var>TStringHashList</var> is a <var>TObject</var> descendant which implements a container for hash values, keys, and data for <var>String</var> types.
</p>
<p>
TStringHashList uses the PStringHashItem type to represent the items stored in the container. This provides a 32-bit hash value, which can reflect the case for the String value if desired. It also includes an untyped pointer to arbitrary data associated with the hashed item (when provided). Items in the container are stored in hash value order, and uses a binary search for retrieval.
@ -92,7 +92,7 @@
Use the Remove method to delete a hash item with the specified String value.
</p>
<p>
Use the Clear method to remove all hashed items in the container.
Use the Clear method to remove all hashed items in the container.
</p>
<p>
Use the Count property to determine the number of hashed items stored in the container.
@ -310,7 +310,7 @@
S contains the key value for the hash item locates in the method. HashOf is called to get the 32-bit hash value, and BinarySearch is called to locate the hash value in List.
</p>
<p>
An overloaded variant provides an untyped pointer in Data that is also used to locate the hash item. If the value in Data does not match the stored value in List, other candidates with the same hash value are considered. A match is found when the Key and Data for the hash item are the same. Otherwise, the return value is set to -1 to indicate that a match was not found.
An overloaded variant provides an untyped pointer in Data that is also used to locate the hash item. If the value in Data does not match the stored value in List, other candidates with the same hash value are considered. A match is found when the Key and Data for the hash item are the same. Otherwise, the return value is set to -1 to indicate that a match was not found.
</p>
<p>
Find is used in the Remove method, and to implement indexed access for the Data property.
@ -406,7 +406,7 @@
<var>Data</var> is an indexed <var>Pointer</var> property which provides access to the storage for a hash item by its key value. The untyped Pointer in the property values is arbitrary data associated with the key value, and must be cast to the type expected in an application.
</p>
<p>
The Find method is called when reading or writing a value in the property. Finds gets the position where the hash item is stored in List using the setting in the CaseSensitive property. If the value in S does not exist when reading a property value, Nil is returned. If the value in S does not exist when writing a property value, the Add method is called to create a new hash item in List with the key in S.
The Find method is called when reading or writing a value in the property. Finds gets the position where the hash item is stored in List using the setting in the CaseSensitive property. If the value in S does not exist when reading a property value, Nil is returned. If the value in S does not exist when writing a property value, the Add method is called to create a new hash item in List with the key in S.
</p>
<p>
Data is the default property for the container, and the value used in an enumerator for the class instance.