mirror of
https://github.com/QB64Official/qb64.git
synced 2024-07-16 21:15:15 +00:00
44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
[$INCLUDE]($INCLUDE) is a metacommand that is used to insert a source code file into your program which is then executed at the point of the insertion.
|
|
|
|
## Syntax
|
|
|
|
> {[REM](REM) | ['](apostrophe) } [$INCLUDE]($INCLUDE): 'sourceFile'
|
|
|
|
## Description
|
|
|
|
* QBasic [Metacommand](Metacommand) must be commented with [REM](REM) or an apostrophe.
|
|
* The sourceFile name must be enclosed in apostrophes and can include a path.
|
|
* $INCLUDE is often used to add functions and subs from an external text QBasic code library.
|
|
* The $INCLUDE metacommand should be the only statement on a line.
|
|
|
|
### How to $INCLUDE a BAS or Text file with a QB64 Program
|
|
|
|
* Assemble the code to be reused into a file.
|
|
* Common extensions are **.BI** (for declarations, usually included in the beginning of a program) or **.BM** (with SUBs and FUNCTIONs, usually included at the end of a program).
|
|
* Any extension can be used, as long as the file contains code in plain text (binary files are not accepted).
|
|
* $INCLUDE any [DIM](DIM), [CONST](CONST), [SHARED](SHARED) arrays or [DATA](DATA) at the **beginning** of the main program code.
|
|
* $INCLUDE [SUB](SUB)s or [FUNCTION](FUNCTION)s at the bottom of the main program code **after any SUB procedures.**
|
|
* **Note:** [TYPE](TYPE) definitions, [DATA](DATA) and [DECLARE LIBRARY](DECLARE-LIBRARY) can be placed inside of sub-procedures.
|
|
* **Compile** the program.
|
|
**Note: Once the program is compiled, the included text files are no longer needed with the program EXE.*
|
|
|
|
## Example(s)
|
|
|
|
```vb
|
|
|
|
** '$INCLUDE:** 'QB.BI'
|
|
|
|
```
|
|
|
|
### More examples
|
|
|
|
* [SelectScreen](SelectScreen) (member-contributed $INCLUDE demo)
|
|
* [FILELIST$](FILELIST$) (member-contributed file search function)
|
|
* [SAVEIMAGE](SAVEIMAGE) (SUB program that creates bitmaps)
|
|
|
|
## See Also
|
|
|
|
* [INTERRUPT](INTERRUPT), [INTERRUPTX](INTERRUPTX)
|
|
* [TYPE](TYPE), [DIM](DIM)
|
|
* [Metacommand](Metacommand)
|