FCL Reference Guide
Total Page:16
File Type:pdf, Size:1020Kb
Free Component Library (FCL): Reference guide. Reference guide for FCL units. Document version 2.1 November 2005 Michaël Van Canneyt Contents 0.1 Overview ........................................ 8 1 Reference for unit ’contnrs’ 9 1.1 Used units ........................................ 9 1.2 Overview ........................................ 9 1.3 Constants, types and variables ............................. 9 1.3.1 Types ...................................... 9 1.4 Procedures and functions ................................ 10 1.4.1 RSHash ..................................... 10 1.5 EDuplicate ....................................... 10 1.6 EKeyNotFound ..................................... 10 1.7 TClassList ........................................ 10 1.7.1 Description ................................... 10 1.7.2 Method overview ................................ 10 1.7.3 Property overview ............................... 10 1.7.4 TClassList.Add ................................. 10 1.7.5 TClassList.Extract ............................... 11 1.7.6 TClassList.Remove ............................... 11 1.7.7 TClassList.IndexOf ............................... 11 1.7.8 TClassList.First ................................. 12 1.7.9 TClassList.Last ................................. 12 1.7.10 TClassList.Insert ................................ 12 1.7.11 TClassList.Items ................................ 12 1.8 TComponentList .................................... 13 1.8.1 Description ................................... 13 1.8.2 Method overview ................................ 13 1.8.3 Property overview ............................... 13 1.8.4 TComponentList.Destroy ............................ 13 1.8.5 TComponentList.Add ............................. 13 1.8.6 TComponentList.Extract ............................ 14 1.8.7 TComponentList.Remove ........................... 14 1 CONTENTS 1.8.8 TComponentList.IndexOf ........................... 14 1.8.9 TComponentList.First ............................. 15 1.8.10 TComponentList.Last ............................. 15 1.8.11 TComponentList.Insert ............................. 15 1.8.12 TComponentList.Items ............................. 15 1.9 TFPHashTable ..................................... 16 1.9.1 Method overview ................................ 16 1.9.2 Property overview ............................... 16 1.9.3 TFPHashTable.Create ............................. 16 1.9.4 TFPHashTable.CreateWith ........................... 16 1.9.5 TFPHashTable.Destroy ............................. 16 1.9.6 TFPHashTable.ChangeTableSize ........................ 16 1.9.7 TFPHashTable.Clear .............................. 17 1.9.8 TFPHashTable.Add ............................... 17 1.9.9 TFPHashTable.Delete ............................. 17 1.9.10 TFPHashTable.Find .............................. 17 1.9.11 TFPHashTable.IsEmpty ............................ 17 1.9.12 TFPHashTable.HashFunction ......................... 17 1.9.13 TFPHashTable.Count .............................. 17 1.9.14 TFPHashTable.HashTableSize ......................... 17 1.9.15 TFPHashTable.Items .............................. 18 1.9.16 TFPHashTable.HashTable ........................... 18 1.9.17 TFPHashTable.VoidSlots ............................ 18 1.9.18 TFPHashTable.LoadFactor ........................... 18 1.9.19 TFPHashTable.AVGChainLen ......................... 18 1.9.20 TFPHashTable.MaxChainLength ....................... 18 1.9.21 TFPHashTable.NumberOfCollisions ...................... 18 1.9.22 TFPHashTable.Density ............................. 19 1.10 TFPObjectList ...................................... 19 1.10.1 Description ................................... 19 1.10.2 Method overview ................................ 19 1.10.3 Property overview ............................... 19 1.10.4 TFPObjectList.Create ............................. 19 1.10.5 TFPObjectList.Destroy ............................. 20 1.10.6 TFPObjectList.Clear .............................. 20 1.10.7 TFPObjectList.Add ............................... 20 1.10.8 TFPObjectList.Delete ............................. 21 1.10.9 TFPObjectList.Exchange ............................ 21 1.10.10 TFPObjectList.Expand ............................. 21 1.10.11 TFPObjectList.Extract ............................. 21 2 CONTENTS 1.10.12 TFPObjectList.Remove ............................. 22 1.10.13 TFPObjectList.IndexOf ............................ 22 1.10.14 TFPObjectList.FindInstanceOf ......................... 22 1.10.15 TFPObjectList.Insert .............................. 23 1.10.16 TFPObjectList.First .............................. 23 1.10.17 TFPObjectList.Last ............................... 23 1.10.18 TFPObjectList.Move .............................. 23 1.10.19 TFPObjectList.Assign ............................. 24 1.10.20 TFPObjectList.Pack .............................. 24 1.10.21 TFPObjectList.Sort ............................... 24 1.10.22 TFPObjectList.Capacity ............................ 25 1.10.23 TFPObjectList.Count .............................. 25 1.10.24 TFPObjectList.OwnsObjects .......................... 25 1.10.25 TFPObjectList.Items .............................. 25 1.10.26 TFPObjectList.List ............................... 26 1.11 THTNode ........................................ 26 1.11.1 Method overview ................................ 26 1.11.2 Property overview ............................... 26 1.11.3 THTNode.CreateWith ............................. 26 1.11.4 THTNode.HasKey ............................... 26 1.11.5 THTNode.Key ................................. 26 1.11.6 THTNode.Data ................................. 26 1.12 TObjectList ....................................... 27 1.12.1 Description ................................... 27 1.12.2 Method overview ................................ 27 1.12.3 Property overview ............................... 27 1.12.4 TObjectList.create ............................... 27 1.12.5 TObjectList.Add ................................ 27 1.12.6 TObjectList.Extract ............................... 28 1.12.7 TObjectList.Remove .............................. 28 1.12.8 TObjectList.IndexOf .............................. 28 1.12.9 TObjectList.FindInstanceOf .......................... 29 1.12.10 TObjectList.Insert ............................... 29 1.12.11 TObjectList.First ................................ 29 1.12.12 TObjectList.Last ................................ 29 1.12.13 TObjectList.OwnsObjects ........................... 30 1.12.14 TObjectList.Items ............................... 30 1.13 TObjectQueue ...................................... 30 1.13.1 Method overview ................................ 30 1.13.2 TObjectQueue.Push .............................. 30 3 CONTENTS 1.13.3 TObjectQueue.Pop ............................... 31 1.13.4 TObjectQueue.Peek .............................. 31 1.14 TObjectStack ...................................... 31 1.14.1 Description ................................... 31 1.14.2 Method overview ................................ 31 1.14.3 TObjectStack.Push ............................... 31 1.14.4 TObjectStack.Pop ............................... 32 1.14.5 TObjectStack.Peek ............................... 32 1.15 TOrderedList ...................................... 32 1.15.1 Description ................................... 32 1.15.2 Method overview ................................ 32 1.15.3 TOrderedList.Create .............................. 32 1.15.4 TOrderedList.Destroy ............................. 33 1.15.5 TOrderedList.Count .............................. 33 1.15.6 TOrderedList.AtLeast ............................. 33 1.15.7 TOrderedList.Push ............................... 34 1.15.8 TOrderedList.Pop ................................ 34 1.15.9 TOrderedList.Peek ............................... 34 1.16 TQueue ......................................... 34 1.16.1 Description ................................... 34 1.17 TStack .......................................... 35 1.17.1 Description ................................... 35 2 Reference for unit ’dbugintf’ 36 2.1 Writing a debug server ................................. 36 2.2 Overview ........................................ 36 2.3 Constants, types and variables ............................. 36 2.3.1 Resource strings ................................ 36 2.3.2 Constants .................................... 37 2.3.3 Types ...................................... 37 2.4 Procedures and functions ................................ 37 2.4.1 InitDebugClient ................................. 37 2.4.2 SendBoolean .................................. 38 2.4.3 SendDateTime ................................. 38 2.4.4 SendDebug ................................... 38 2.4.5 SendDebugEx ................................. 38 2.4.6 SendDebugFmt ................................. 39 2.4.7 SendDebugFmtEx ............................... 39 2.4.8 SendInteger ................................... 39 2.4.9 SendMethodEnter ............................... 40 4 CONTENTS 2.4.10 SendMethodExit ................................ 40 2.4.11 SendPointer ................................... 40 2.4.12 SendSeparator ................................. 41 2.4.13 StartDebugServer ................................ 41 3 Reference for unit ’iostream’ 42 3.1 Used units ........................................ 42 3.2 Overview ........................................ 42 3.3 Constants, types and variables ............................. 42 3.3.1 Types ...................................... 42 3.4 EIOStreamError ....................................