Difference between revisions of "$INCLUDE"

From QB64 Wiki
Jump to navigation Jump to search
imported>Clippy
m
imported>Clippy
m
Line 6: Line 6:




* $INCLUDE is often used to add functions and subs from an external text library.
* There must always be a [[REM]] or [[REM|']] comment before the $INCLUDE metacommand.
* There must always be a [[REM]] or [[REM|']] comment before the $INCLUDE metacommand.
* The source file MUST have REM or apostrophies around the name.
* The source file MUST have REM or apostrophies around the name.
* The source file included can contain any BASIC statement except [[GOTO]]  
* The source file included can contain any BASIC statement except [[GOTO]]  
* QB 4.5 can use [[DECLARE]] SUB in BI files such as [[QB.BI]]. '''QB64''' ignores Qbasic's [[DECLARE]] statements.
* QB 4.5 can use [[DECLARE]] SUB in BI files such as [[QB.BI]]. '''QB64''' ignores Qbasic's [[DECLARE]] statements.
* '''QB64 users can use all statements in their include files.''' The $INCLUDE of a [[SUB]] or a [[FUNCTION]] should be after ALL of your program code including SUBs and Functions! Otherwise you will get the '''QB64''' compiler error "Statement cannot be placed between SUB/FUNCTIONs"
* '''QB64 users can use all statements in their include files. See below.'''
* The $INCLUDE metacommand should be the only statement on a line since execution progresses ''after'' the line of the metacommand.
* The $INCLUDE metacommand should be the only statement on a line since execution progresses ''after'' the code line.
* $INCLUDE is often used to [[DECLARE]] functions and subs used in an external library.
 




Line 18: Line 19:


:* 1) Assemble your text code into a TEXT file and name it something with a '''.BI''' or '''.BM''' file name extension. '''NOT as .TXT!'''
:* 1) Assemble your text code into a TEXT file and name it something with a '''.BI''' or '''.BM''' file name extension. '''NOT as .TXT!'''
:* 2) [[$INCLUDE]] any [[DEFINT]], [[DIM]], [[TYPE]], [[SHARED]] arrays or [[DATA]] at the very '''beginning''' of the main program code.  
:* 2) [[$INCLUDE]] any [[DEFINT]], [[DIM]], [[CONST]], [[SHARED]] arrays or [[DATA]] at the very '''beginning''' of the main program code.  
:* 3) $INCLUDE [[SUB]]s or [[FUNCTION]]s at the very bottom of the main program code '''AFTER any SUB procedures.'''
:* 3) $INCLUDE [[SUB]]s or [[FUNCTION]]s at the very bottom of the main program code '''AFTER any SUB procedures.'''
:: ''Note:'' [[TYPE]] definitions, [[DATA]] and [[DECLARE LIBRARY]] can be placed inside of sub-procedures.
:* 4) '''Compile''' the program with the included text files '''in the QB64 folder!''' Save the text files to use them like '''Library files'''.
:* 4) '''Compile''' the program with the included text files '''in the QB64 folder!''' Save the text files to use them like '''Library files'''.



Revision as of 15:18, 19 July 2012

$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'


  • $INCLUDE is often used to add functions and subs from an external text library.
  • There must always be a REM or ' comment before the $INCLUDE metacommand.
  • The source file MUST have REM or apostrophies around the name.
  • The source file included can contain any BASIC statement except GOTO
  • QB 4.5 can use DECLARE SUB in BI files such as QB.BI. QB64 ignores Qbasic's DECLARE statements.
  • QB64 users can use all statements in their include files. See below.
  • The $INCLUDE metacommand should be the only statement on a line since execution progresses after the code line.


How to $INCLUDE a BAS or Text file with a QB64 Program
  • 1) Assemble your text code into a TEXT file and name it something with a .BI or .BM file name extension. NOT as .TXT!
  • 2) $INCLUDE any DEFINT, DIM, CONST, SHARED arrays or DATA at the very beginning of the main program code.
  • 3) $INCLUDE SUBs or FUNCTIONs at the very bottom of the main program code AFTER any SUB procedures.
Note: TYPE definitions, DATA and DECLARE LIBRARY can be placed inside of sub-procedures.
  • 4) Compile the program with the included text files in the QB64 folder! Save the text files to use them like Library files.


Example: '$INCLUDE: 'QB.BI'


See Library Examples:


See also:



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