Standard Units Reference Guide
Total Page:16
File Type:pdf, Size:1020Kb
Free Pascal supplied units : Reference guide. Reference guide for standard Free Pascal units. 1.9 April 2002 Michaël Van Canneyt Florian Klämpfl Contents 1 The CRT unit. 28 1.1 Types, Variables, Constants ............................... 28 1.2 Procedures and Functions ................................ 29 AssignCrt ........................................ 29 CursorBig ........................................ 30 ClrEol .......................................... 30 ClrScr .......................................... 30 CursorOff ........................................ 31 CursorOn ........................................ 31 Delay .......................................... 31 DelLine ......................................... 32 GotoXY ......................................... 32 HighVideo ........................................ 33 InsLine ......................................... 33 KeyPressed ....................................... 34 LowVideo ........................................ 34 NormVideo ....................................... 35 NoSound ........................................ 35 ReadKey ......................................... 35 Sound .......................................... 36 TextBackground ..................................... 36 TextColor ........................................ 37 TextMode ........................................ 37 WhereX ......................................... 37 WhereY ......................................... 38 Window ......................................... 38 2 The DOS unit. 40 2.1 Types, Variables, Constants ............................... 40 Constants ........................................ 40 File attributes .................................. 40 1 CONTENTS fmXXXX .................................... 40 Other ...................................... 41 Types .......................................... 41 Variables ........................................ 43 2.2 Function list by category ................................ 43 File handling ...................................... 43 Directory and disk handling ............................... 44 Process handling .................................... 44 System information ................................... 44 2.3 Functions and Procedures ................................ 45 AddDisk ......................................... 45 DiskFree ......................................... 45 DiskSize ......................................... 46 DosExitCode ...................................... 46 DosVersion ....................................... 47 EnvCount ........................................ 48 EnvStr .......................................... 48 Exec ........................................... 48 FExpand ......................................... 48 FindClose ........................................ 49 FindFirst ......................................... 49 FindNext ........................................ 50 FSearch ......................................... 50 FSplit .......................................... 51 GetCBreak ....................................... 51 GetDate ......................................... 52 GetEnv ......................................... 52 GetFAttr ......................................... 53 GetFTime ........................................ 53 GetIntVec ........................................ 54 GetLongName ...................................... 54 GetShortName ..................................... 55 GetTime ......................................... 55 GetVerify ........................................ 56 Intr ............................................ 56 Keep ........................................... 56 MSDos ......................................... 56 PackTime ........................................ 57 SetCBreak ........................................ 57 SetDate ......................................... 58 2 CONTENTS SetFAttr ......................................... 58 SetFTime ........................................ 58 SetIntVec ........................................ 59 SetTime ......................................... 59 SetVerify ........................................ 59 SwapVectors ...................................... 59 UnPackTime ...................................... 60 3 The DXELOAD unit 61 3.1 Introduction ....................................... 61 3.2 Constants, types and variables ............................. 61 Constants ........................................ 61 Types .......................................... 61 3.3 Functions and Procedures ................................ 61 dxe_load ......................................... 61 4 The EMU387 unit 63 4.1 Functions and procedures ................................ 63 npxsetup ......................................... 63 5 The GETOPTS unit. 64 5.1 Types, Constants and variables : ............................ 64 Constants ........................................ 64 Types .......................................... 64 Variables ........................................ 65 5.2 Procedures and functions ................................ 65 GetLongOpts ...................................... 65 Getopt .......................................... 65 6 The GPM unit 68 6.1 Introduction ....................................... 68 6.2 Constants, types and variables ............................. 68 constants ........................................ 68 Types .......................................... 69 Variables ........................................ 70 6.3 Functions and procedures ................................ 70 Gpm_AnyDouble .................................... 70 Gpm_AnySingle .................................... 71 Gpm_AnyTriple ..................................... 71 Gpm_Close ....................................... 71 Gpm_FitValues ..................................... 71 3 CONTENTS Gpm_FitValuesM .................................... 71 Gpm_GetEvent ..................................... 72 Gpm_GetLibVersion .................................. 73 Gpm_GetServerVersion ................................. 73 Gpm_GetSnapshot ................................... 73 Gpm_LowerRoi ..................................... 73 Gpm_Open ....................................... 74 Gpm_PopRoi ...................................... 74 Gpm_PushRoi ...................................... 74 Gpm_RaiseRoi ..................................... 74 Gpm_Repeat ...................................... 75 Gpm_StrictDouble ................................... 75 Gpm_StrictSingle .................................... 75 Gpm_StrictTriple .................................... 75 7 The GO32 unit 76 7.1 Introduction ....................................... 76 7.2 Protected mode memory organization ......................... 76 What is DPMI ...................................... 76 Selectors and descriptors ................................ 76 FPC specialities ..................................... 77 DOS memory access ................................... 77 I/O port access ..................................... 77 Processor access ..................................... 77 Interrupt redirection ................................... 77 Handling interrupts with DPMI ............................. 78 Protected mode interrupts vs. Real mode interrupts .................. 78 Creating own interrupt handlers ............................ 78 Disabling interrupts ................................... 78 Hardware interrupts ................................... 78 Software interrupts ................................... 80 Real mode callbacks .................................. 82 7.3 Types, Variables and Constants ............................. 83 Constants ........................................ 83 Constants returned by get_run_mode ..................... 83 Processor flags constants ............................ 83 Predefined types ..................................... 83 Variables. ........................................ 84 7.4 Functions and Procedures ................................ 85 allocate_ldt_descriptors ................................. 85 4 CONTENTS allocate_memory_block ................................. 87 copyfromdos ...................................... 87 copytodos ........................................ 87 create_code_segment_alias_descriptor ......................... 88 disable .......................................... 88 dosmemfillchar ..................................... 88 dosmemfillword ..................................... 89 dosmemget ....................................... 89 dosmemmove ...................................... 90 dosmemput ....................................... 90 enable .......................................... 90 free_ldt_descriptor ................................... 91 free_memory_block ................................... 91 free_rm_callback .................................... 91 get_cs .......................................... 92 get_descriptor_access_rights .............................. 92 get_ds .......................................... 92 get_linear_addr ..................................... 92 get_meminfo ...................................... 93 get_next_selector_increment_value ........................... 94 get_page_size ...................................... 94 get_pm_interrupt .................................... 94 get_rm_callback ..................................... 95 get_rm_interrupt .................................... 97 get_run_mode ...................................... 98 get_segment_base_address ............................... 98 get_segment_limit