Difference between revisions of "$INCLUDE"

From QB64 Wiki
Jump to navigation Jump to search
(Created page with '$INCLUDE is a metacommand that is used to insert a source file into your program which is then executed at the point of the insertion. The source file included can contain any …')
 
m (Fix link)
 
(42 intermediate revisions by 3 users not shown)
Line 1: Line 1:
$INCLUDE is a metacommand that is used to insert a source file into your program which is then executed at the point of the insertion.
+
[[$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.
  
  
The source file included can contain any BASIC statement except SUB or GOTO.
+
{{PageSyntax}}
 +
: {[[REM]] | [[apostrophe|']] } [[$INCLUDE]]: '{{Parameter|sourceFile}}'
  
  
''Syntax:'' REM|' $INCLUDE: 'sourcefile'
+
{{PageDescription}}
 +
* QBasic [[Metacommand|metacommands]] must be commented with [[REM]] or an apostrophe.
 +
* The {{Parameter|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.
  
  
''Note:'' The $INCLUDE metacommand should be the last statement on a line since execution progresses ''after'' the line of the $INCLUDE metacommand.
+
===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]], [[CONST]], [[SHARED]] arrays or [[DATA]] at the '''beginning''' of the main program code.
 +
* $INCLUDE [[SUB]]s or [[FUNCTION]]s at the bottom of the main program code '''after any SUB procedures.'''
 +
** '''Note:''' [[TYPE]] definitions, [[DATA]] and [[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.''
  
  
''Note 2:'' $INCLUDE is also often used to [[DECLARE]] functions and subs used in a external library.
+
{{PageExamples}}
 +
{{CodeStart}}''' '$INCLUDE:''' 'QB.BI'{{CodeEnd}}
  
  
''Note 3:'' There must always be a REM or ' comment before the $INCLUDE metacommand.
+
===More examples===
 +
* [[SelectScreen]] (member-contributed $INCLUDE demo)
 +
* [[FILELIST$]] (member-contributed file search function)
 +
* [[SAVEIMAGE]] (SUB program that creates bitmaps)
 +
 
 +
 
 +
{{PageSeeAlso}}
 +
* [[INTERRUPT]], [[INTERRUPTX]]
 +
* [[TYPE]], [[DIM]]
 +
* [[Metacommand]]
 +
 
 +
 
 +
{{PageNavigation}}

Latest revision as of 15:36, 17 February 2021

$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 | ' } $INCLUDE: sourceFile


Description

  • QBasic metacommands must be commented with 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, CONST, SHARED arrays or DATA at the beginning of the main program code.
  • $INCLUDE SUBs or FUNCTIONs at the bottom of the main program code after any SUB procedures.
  • Compile the program.
  • Note: Once the program is compiled, the included text files are no longer needed with the program EXE.


Examples

'$INCLUDE: 'QB.BI'


More examples


See also



Navigation:
Keyword Reference - Alphabetical
Keyword Reference - By Usage
Main Wiki Page