Sign in Join
FPDoc Onlineexperiment

TXMLConfig.GetListItemCount function

Member of TXMLConfigpublicIn unit Laz2_XMLCfg

Gets the number of values with the specified name found in the given path.

Declaration

pascal
function GetListItemCount(const APath: string; const AItemName: string; 
 const aLegacyList: Boolean): Integer

Arguments

APath

Path the XML nodes for the list.

AItemName

Name for the list items in APath.

aLegacyList

True when the Count value from an older LazUtils version is used.

Function result

Number of items in the list identified by APath.

Description

GetListItemCount is an Integer function used to get the number of values with the name in AItemName found on the path in APath.

ALegacyList indicates whether the list includes a "Count" value from a previous LazUtils version. When ALegacyList is True, the "Count" value is used (or 0 as the default). When set to False, a list of XML nodes is retrieved from APath with the name in AItemName. The length of the resulting list node list is used as the return value, or 0 when no XML nodes are found with the specified name.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.