SHELL: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
(Created page with "The SHELL statement allows a program to run external programs or command line statements in Windows, macOS and Linux. {{PageSyntax}} : SHELL [{{Parameter|DOSCommand$}}] : SHELL ['''_DONTWAIT'''] ['''_HIDE'''] [{{Parameter|DOSCommand$}}] {{PageDescription}} * If the ''DOSCommand$'' STRING parameter isn't used, the "command console" is opened and execution is halted until the user closes it manually. * If _DONTWAIT is used, the '''QB64''' program do...")
 
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 14: Line 14:
* Commands can be a mixture of [[STRING|strings]] and string variables added together using the + [[concatenation]] operator.
* Commands can be a mixture of [[STRING|strings]] and string variables added together using the + [[concatenation]] operator.
* Command text can be in upper or lower case. Use single spacing between items and options.
* Command text can be in upper or lower case. Use single spacing between items and options.
* '''QB64''' automatically uses CMD /C when using [[SHELL]], but it is allowed in a command string. {{text|Note: CMD alone may lock up program.|red}}
* '''QB64''' automatically uses CMD /C when using [[SHELL]], but it is allowed in a command string. {{Text|Note: CMD alone may lock up program.|red}}
** '''Note: Some commands may not work without adding CMD /C to the start of the command line.'''
** '''Note: Some commands may not work without adding CMD /C to the start of the command line.'''
* '''QB64''' program screens will not get distorted, minimized or freeze the program like QBasic fullscreen modes would.  
* '''QB64''' program screens will not get distorted, minimized or freeze the program like QBasic fullscreen modes would.
* '''QB64''' can use long path folder names and file names and [[SHELL]] command lines can be longer than 124 characters.
* '''QB64''' can use long path folder names and file names and [[SHELL]] command lines can be longer than 124 characters.
* In Windows, use additional [[CHR$]](34) quotation marks around folder or file names that contain spaces.
* In Windows, use additional [[CHR$]](34) quotation marks around folder or file names that contain spaces.
Line 22: Line 22:
*'''NOTE: Use [[CHDIR]] instead of CD as SHELL commands cannot affect the current program path.'''
*'''NOTE: Use [[CHDIR]] instead of CD as SHELL commands cannot affect the current program path.'''


 
=== QBasic/QuickBASIC ===
==QBasic/QuickBASIC==
* '''QBasic BAS files could be run like compiled programs without returning to the IDE when [[SYSTEM]] was used to [[END|end]] them.'''
* '''QBasic BAS files could be run like compiled programs without returning to the IDE when [[SYSTEM]] was used to [[END|end]] them.'''
* A user would invoke it with {{InlineCode}}SHELL "QB.EXE /L /RUN program.BAS"{{InlineCodeEnd}}
* A user would invoke it with {{InlineCode}}SHELL "QB.EXE /L /RUN program.BAS"{{InlineCodeEnd}}
Line 30: Line 29:
{{PageExamples}}
{{PageExamples}}
''Example 1:'' When working with file or folder names with spaces, add quotation marks around the path and/or file name with [[CHR$]](34).
''Example 1:'' When working with file or folder names with spaces, add quotation marks around the path and/or file name with [[CHR$]](34).
{{CodeStart}} '' ''
{{CodeStart}}
{{Cl|SHELL}} {{Cl|_HIDE}} "dir " + {{Cl|CHR$}}(34) + "free cell.ico" + {{Cl|CHR$}}(34) + " /b > temp.dir" '' ''
{{Cl|SHELL}} {{Cl|_HIDE}} "dir " + {{Cl|CHR$}}(34) + "free cell.ico" + {{Cl|CHR$}}(34) + " /b > temp.dir"
{{Cl|SHELL}} "start Notepad temp.dir" ' display temp file contents in Notepad window '' ''
{{Cl|SHELL}} "start Notepad temp.dir" ' display temp file contents in Notepad window
{{CodeEnd}}
{{CodeEnd}}
:{{small|Contents of ''temp.dir'' text file:}}
{{TextStart}}Free Cell.ico
{{TextStart}}Free Cell.ico
{{TextEnd}}
{{TextEnd}}
{{Small|Contents of the temp.dir text file}}




Line 42: Line 41:
{{CodeStart}}
{{CodeStart}}
{{Cl|INPUT}} "Enter a file name to read in Notepad: ", filename$
{{Cl|INPUT}} "Enter a file name to read in Notepad: ", filename$
{{Cl|SHELL}} "CMD /C start /max notepad " + filename$  ' display in Notepad full screen in XP or NT  
{{Cl|SHELL}} "CMD /C start /max notepad " + filename$  ' display in Notepad full screen in XP or NT


'{{Cl|SHELL}} "start /min notepad /p " + filename$ ' taskbar print using QB64 CMD /C not necessary
'{{Cl|SHELL}} "start /min notepad /p " + filename$ ' taskbar print using QB64 CMD /C not necessary
{{CodeEnd}}
{{CodeEnd}}


:''Explanation:'' Notepad is an easy program to open in Windows as no path is needed. Windows NT computers, including XP, use CMD /C where older versions of DOS don't require any command reference. The top command opens Notepad in a normal window for a user to view the file. They can use Notepad to print it. The second command places Notepad file in the taskbar and prints it automatically. The filename variable is added by the program using proper spacing.  
:''Explanation:'' Notepad is an easy program to open in Windows as no path is needed. Windows NT computers, including XP, use CMD /C where older versions of DOS don't require any command reference. The top command opens Notepad in a normal window for a user to view the file. They can use Notepad to print it. The second command places Notepad file in the taskbar and prints it automatically. The filename variable is added by the program using proper spacing.


::*'''Start''' is used to allow a Basic program to run without waiting for Notepad to be closed.
::*'''Start''' is used to allow a Basic program to run without waiting for Notepad to be closed.
Line 60: Line 59:
  PRINT currentpath$
  PRINT currentpath$


  {{Cl|FUNCTION}} Path$  
  {{Cl|FUNCTION}} Path$
   {{Cl|SHELL}} {{Cl|_HIDE}} "CD > D0S-DATA.INF"  'code to hide window in '''QB64'''
   {{Cl|SHELL}} {{Cl|_HIDE}} "CD > D0S-DATA.INF"  'code to hide window in '''QB64'''
   {{Cl|OPEN}} "D0S-DATA.INF" FOR {{Cl|APPEND}} AS #1  'this may create the file
   {{Cl|OPEN}} "D0S-DATA.INF" FOR {{Cl|APPEND}} AS #1  'this may create the file
         L% = {{Cl|LOF}}(1)          'verify that file and data exist
         L% = {{Cl|LOF}}(1)          'verify that file and data exist
   {{Cl|CLOSE}} #1  
   {{Cl|CLOSE}} #1
   {{Cl|IF}} L% {{Cl|THEN}}                      'read file if it has data
   {{Cl|IF}} L% {{Cl|THEN}}                      'read file if it has data
     {{Cl|OPEN}} "D0S-DATA.INF" FOR {{Cl|INPUT (file mode)|INPUT}} AS #1
     {{Cl|OPEN}} "D0S-DATA.INF" FOR {{Cl|INPUT (file mode)|INPUT}} AS #1
Line 73: Line 72:
   END IF
   END IF
   {{Cl|KILL}} "D0S-DATA.INF"              'deleting the file is optional
   {{Cl|KILL}} "D0S-DATA.INF"              'deleting the file is optional
  {{Cl|END FUNCTION}} '' ''
  {{Cl|END FUNCTION}}
{{CodeEnd}}
{{CodeEnd}}
{{small|Code by Ted Weissgerber}}
{{Small|Code by Ted Weissgerber}}
:''Explanation:'' The '''SHELL "CD"''' statement requests the current working path. This info is normally printed to the screen, but the '''>''' pipe character sends the information to the DOS-DATA.INF file instead('''QB64''' can use [[_HIDE]] to not display the DOS window). The function uses the [[OPEN]] FOR [[APPEND]] mode to check for the file and the data([[INPUT (file mode)|INPUT]] would create an error if file does not exist). The current path is listed on one line of the file. The file is opened and [[LINE INPUT (file statement)|LINE INPUT]] returns one line of the file text. The function adds a "\" so that the Path$ returned can be used in another file statement by just adding a file name. Save the Path$ to another variable for later use when the program has moved to another directory.
:''Explanation:'' The '''SHELL "CD"''' statement requests the current working path. This info is normally printed to the screen, but the '''>''' pipe character sends the information to the DOS-DATA.INF file instead('''QB64''' can use [[_HIDE]] to not display the DOS window). The function uses the [[OPEN]] FOR [[APPEND]] mode to check for the file and the data([[INPUT (file mode)|INPUT]] would create an error if file does not exist). The current path is listed on one line of the file. The file is opened and [[LINE INPUT (file statement)|LINE INPUT]] returns one line of the file text. The function adds a "\" so that the Path$ returned can be used in another file statement by just adding a file name. Save the Path$ to another variable for later use when the program has moved to another directory.
: In '''QB64''' you can simply use the [[_CWD$]] statement for the same purpose of the example above.
: In '''QB64''' you can simply use the [[_CWD$]] statement for the same purpose of the example above.
Line 81: Line 80:


''Example 4:'' Determining if a drive or path exists. Cannot use with a file name specification.
''Example 4:'' Determining if a drive or path exists. Cannot use with a file name specification.
{{CodeStart}} '' ''
{{CodeStart}}
{{Cl|LINE INPUT}} "Enter a drive or path (no file name): ", DirPath$
{{Cl|LINE INPUT}} "Enter a drive or path (no file name): ", DirPath$
{{Cl|IF}} PathExist%(DirPath$) {{Cl|THEN}} PRINT "Drive Path exists!" {{Cl|ELSE}} PRINT "Drive Path does not exist!"
{{Cl|IF}} PathExist%(DirPath$) {{Cl|THEN}} PRINT "Drive Path exists!" {{Cl|ELSE}} PRINT "Drive Path does not exist!"
Line 95: Line 94:
{{Cl|CLOSE}} #1
{{Cl|CLOSE}} #1
{{Cl|KILL}} "D0S-DATA.INF"              'delete data file optional
{{Cl|KILL}} "D0S-DATA.INF"              'delete data file optional
{{Cl|END FUNCTION}} '' ''
{{Cl|END FUNCTION}}
{{CodeEnd}}
{{CodeEnd}}
{{small|Code by Ted Weissgerber}}
{{Small|Code by Ted Weissgerber}}
:''Explanation: IF Exist'' checks for the drive path. ''\Nul'' allows an emply folder at end of path. ''Echo'' prints '''yes''' in the file if it exists.
:''Explanation: IF Exist'' checks for the drive path. ''\Nul'' allows an emply folder at end of path. ''Echo'' prints '''yes''' in the file if it exists.
: In '''QB64''' you can simply use the [[_FILEEXISTS]] statement for the same purpose of the example above.
: In '''QB64''' you can simply use the [[_FILEEXISTS]] statement for the same purpose of the example above.
Line 106: Line 105:
{{TextEnd}}
{{TextEnd}}
'''Created file's text:'''
'''Created file's text:'''
{{TextStart}}Default  Name                          
{{TextStart}}Default  Name
   FALSE    Microsoft XPS Document Writer  
   FALSE    Microsoft XPS Document Writer
   TRUE    HP Photosmart C7200 series    
   TRUE    HP Photosmart C7200 series
   FALSE    HP Officejet Pro 8600        
   FALSE    HP Officejet Pro 8600
   FALSE    Fax
   FALSE    Fax
{{TextEnd}}
{{TextEnd}}
Line 119: Line 118:
{{TextEnd}}
{{TextEnd}}
: After executing this program, and then running the first snippet again, we see the following '''contents of the text file:'''
: After executing this program, and then running the first snippet again, we see the following '''contents of the text file:'''
{{TextStart}}Default  Name  
{{TextStart}}Default  Name
   FALSE    Microsoft XPS Document Writer  
   FALSE    Microsoft XPS Document Writer
   FALSE    HP Photosmart C7200 series    
   FALSE    HP Photosmart C7200 series
   TRUE    HP Officejet Pro 8600        
   TRUE    HP Officejet Pro 8600
   FALSE    Fax
   FALSE    Fax
{{TextEnd}}
{{TextEnd}}


 
=== More examples ===
===More examples===
* [[FILELIST$ (function)]]
''See examples in:''
* [[Windows Libraries#File_Exist|FileExist Library Function]]
* [[FILELIST$ (function)]] (member-contributed file search routine)
* ''File Exist'' C++ Function that does not create a temp file: [[Windows_Libraries#File_Exist|FileExist Library Function]]




{{PageSeeAlso}}
{{PageSeeAlso}}
* [https://qb64phoenix.com/forum/showthread.php?tid=1282 Featured in our "Keyword of the Day" series]
* [[SHELL (function)]], [[_SHELLHIDE]]
* [[SHELL (function)]], [[_SHELLHIDE]]
* [[FILES]], [[CHDIR]], [[MKDIR]]
* [[FILES]], [[CHDIR]], [[MKDIR]]
Line 141: Line 139:
* [[_HIDE]], [[_DONTWAIT]]
* [[_HIDE]], [[_DONTWAIT]]
* [[_CONSOLE]], [[$CONSOLE]]
* [[_CONSOLE]], [[$CONSOLE]]
* [[$SCREENHIDE]], [[$SCREENSHOW]] {{text|(QB64 [[Metacommand]]s)}}
* [[$SCREENHIDE]], [[$SCREENSHOW]]
* [[_SCREENHIDE]], [[_SCREENSHOW]]
* [[_SCREENHIDE]], [[_SCREENSHOW]]
* [[FILELIST$]], [[PDS_(7.1)_Procedures#DIR.24|DIR$]] {{text|(member-contributed file list array function)}}
* [[FILELIST$]], [[PDS(7.1) Procedures#DIR$|DIR$]]
 
* [[Windows Libraries#File_Dialog_Boxes|Windows Open and Save Dialog Boxes]]
 
* [[C Libraries#Console_Window|C Console Library]]
===Extra reference===
* [[Windows_Libraries#File_Dialog_Boxes|Windows Open and Save Dialog Boxes]]
* [[C_Libraries#Console_Window|C Console Library]]
* [[Windows Printer Settings]]
* [[Windows Printer Settings]]




{{PageNavigation}}
{{PageNavigation}}

Latest revision as of 18:11, 25 May 2024

The SHELL statement allows a program to run external programs or command line statements in Windows, macOS and Linux.


Syntax

SHELL [DOSCommand$]
SHELL [_DONTWAIT] [_HIDE] [DOSCommand$]


Description

  • If the DOSCommand$ STRING parameter isn't used, the "command console" is opened and execution is halted until the user closes it manually.
  • If _DONTWAIT is used, the QB64 program doesn't wait for the SHELLed program/command to end.
  • When the _HIDE action is used, the console window is hidden and screen info can be "redirected" (using redirection characters like >) to a file (recommended).
  • Commands are external commands, according to the user's operating system, passed as strings enclosed in quotes or string variables.
  • Commands can be a mixture of strings and string variables added together using the + concatenation operator.
  • Command text can be in upper or lower case. Use single spacing between items and options.
  • QB64 automatically uses CMD /C when using SHELL, but it is allowed in a command string. Note: CMD alone may lock up program.
    • Note: Some commands may not work without adding CMD /C to the start of the command line.
  • QB64 program screens will not get distorted, minimized or freeze the program like QBasic fullscreen modes would.
  • QB64 can use long path folder names and file names and SHELL command lines can be longer than 124 characters.
  • In Windows, use additional CHR$(34) quotation marks around folder or file names that contain spaces.
  • For other operating systems, both the quotation mark character and the apostrophe can be used to enclose a file name that contains spaces.
  • NOTE: Use CHDIR instead of CD as SHELL commands cannot affect the current program path.

QBasic/QuickBASIC

  • QBasic BAS files could be run like compiled programs without returning to the IDE when SYSTEM was used to end them.
  • A user would invoke it with SHELL "QB.EXE /L /RUN program.BAS"


Examples

Example 1: When working with file or folder names with spaces, add quotation marks around the path and/or file name with CHR$(34). 

SHELL _HIDE "dir " + CHR$(34) + "free cell.ico" + CHR$(34) + " /b > temp.dir"
SHELL "start Notepad temp.dir" ' display temp file contents in Notepad window

Free Cell.ico
Contents of the temp.dir text file


Example 2: Opening a Windows program (Notepad) to read or print a Basic created text file. 

INPUT "Enter a file name to read in Notepad: ", filename$
SHELL "CMD /C start /max notepad " + filename$  ' display in Notepad full screen in XP or NT

'SHELL "start /min notepad /p " + filename$ ' taskbar print using QB64 CMD /C not necessary
Explanation: Notepad is an easy program to open in Windows as no path is needed. Windows NT computers, including XP, use CMD /C where older versions of DOS don't require any command reference. The top command opens Notepad in a normal window for a user to view the file. They can use Notepad to print it. The second command places Notepad file in the taskbar and prints it automatically. The filename variable is added by the program using proper spacing.
  • Start is used to allow a Basic program to run without waiting for Notepad to be closed.
  • /min places the window into the taskbar. /max is fullscreen and no option is a normal window.
  • Notepad's /p option prints the file contents, even with USB printers.


Example 3: Function that returns the program's current working path. 

 currentpath$ = Path$ ' function call saves a path for later program use
 PRINT currentpath$

 FUNCTION Path$
   SHELL _HIDE "CD > D0S-DATA.INF"   'code to hide window in QB64
   OPEN "D0S-DATA.INF" FOR APPEND AS #1  'this may create the file
        L% = LOF(1)          'verify that file and data exist
   CLOSE #1
   IF L% THEN                       'read file if it has data
     OPEN "D0S-DATA.INF" FOR INPUT AS #1
     LINE INPUT #1, line$           'read only line in file
     Path$ = line$ + "\"            'add slash to path so only a filename needs added later
     CLOSE #1
   ELSE : Path = ""                 'returns zero length string if path not found
   END IF
   KILL "D0S-DATA.INF"              'deleting the file is optional
 END FUNCTION
Code by Ted Weissgerber
Explanation: The SHELL "CD" statement requests the current working path. This info is normally printed to the screen, but the > pipe character sends the information to the DOS-DATA.INF file instead(QB64 can use _HIDE to not display the DOS window). The function uses the OPEN FOR APPEND mode to check for the file and the data(INPUT would create an error if file does not exist). The current path is listed on one line of the file. The file is opened and LINE INPUT returns one line of the file text. The function adds a "\" so that the Path$ returned can be used in another file statement by just adding a file name. Save the Path$ to another variable for later use when the program has moved to another directory.
In QB64 you can simply use the _CWD$ statement for the same purpose of the example above.


Example 4: Determining if a drive or path exists. Cannot use with a file name specification. 

LINE INPUT "Enter a drive or path (no file name): ", DirPath$
IF PathExist%(DirPath$) THEN PRINT "Drive Path exists!" ELSE PRINT "Drive Path does not exist!"
END

FUNCTION PathExist% (Path$)
PathExist% = 0
IF LEN(Path$) = 0 THEN EXIT FUNCTION 'no entry
IF LEN(ENVIRON$("OS")) THEN CMD$ = "CMD /C " ELSE CMD$ = "COMMAND /C "
SHELL _HIDE CMD$ + "If Exist " + Path$ + "\nul echo yes > D0S-DATA.INF"
OPEN "D0S-DATA.INF" FOR APPEND AS #1
IF LOF(1) THEN PathExist% = -1             'yes will be in file if path exists
CLOSE #1
KILL "D0S-DATA.INF"               'delete data file optional
END FUNCTION
Code by Ted Weissgerber
Explanation: IF Exist checks for the drive path. \Nul allows an emply folder at end of path. Echo prints yes in the file if it exists.
In QB64 you can simply use the _FILEEXISTS statement for the same purpose of the example above.


Snippet 1: When looking for printers this command gives you a file list with the default printer marked as TRUE: 

SHELL _HIDE "CMD /C" + "wmic printer get name,default > default.txt"

Created file's text: 

Default  Name
  FALSE    Microsoft XPS Document Writer
  TRUE     HP Photosmart C7200 series
  FALSE    HP Officejet Pro 8600
  FALSE    Fax
Explanation: LINE INPUT could be used to find the printer names as STRING variables.


Snippet 2: Here is the code to set the default printer to the "HP Officejet Pro 8600": 

SHELL _HIDE "CMD /C" + "wmic printer where name='HP Officejet Pro 8600' call setdefaultprinter"
After executing this program, and then running the first snippet again, we see the following contents of the text file:
Default  Name
  FALSE    Microsoft XPS Document Writer
  FALSE    HP Photosmart C7200 series
  TRUE     HP Officejet Pro 8600
  FALSE    Fax

More examples


See also


Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link
Retrieved from "https://qb64phoenix.com/qb64wiki/index.php?title=SHELL&oldid=8924"