1
1
Fork 0
mirror of https://github.com/QB64-Phoenix-Edition/QB64pe.git synced 2024-07-01 13:50:36 +00:00
QB64-PE/internal/help/_FILEEXISTS.txt
2017-10-10 11:55:21 -03:00

32 lines
1.1 KiB
Plaintext

{{DISPLAYTITLE:_FILEEXISTS}}
The '''_FILEEXISTS''' function determines if a designated file name exists and returns true (-1) or false (0).
{{PageSyntax}}
: {{Parameter|theFileExists%}} = [[_FILEEXISTS]]({{Parameter|filename$}})
{{PageDescription}}
* The {{Parameter|filename$}} parameter can be a literal or variable [[STRING|string]] value that can include a path.
* The function returns -1 when a file exists and 0 when it does not.
* The function reads the system information directly without using a [[SHELL]] procedure.
* The function will use the appropriate Operating System path separators. [[_OS$]] can determine the operating system.
* '''This function does not guarantee that a file can be accessed or opened, just that it exists.'''
{{PageExamples}}
{{Parameter|Example:'' Checks if a file exists before opening it.
{{CodeStart}}
{{Cl|IF}} {{Cl|_FILEEXISTS}}("mysettings.ini") THEN
{{Cl|PRINT}} "Settings file found."
{{Cl|END IF}}
{{CodeEnd}}}}
{{PageSeeAlso}}
* [[_DIREXISTS]], [[_OS$]]
* [[SHELL]], [[FILES]]
* [[KILL]]
{{PageNavigation}}