====== OSClose statement  ======

 


 
==== Description ====
 
Close an operating system file that has been opened with an [[osopen|OSOpen statement]].
 
==== Syntax ====
 
**OSClose** //filevar//
 
==== Parameters ====
 
The OSClose statement has the following parameter.

^Parameter^Description^
|//filevar//|The variable to which the operating system file was assigned when it was opened with an OSOpen statement.|
\\   \\ \\ You must specifically close any file opened with OSOpen.|

 
==== Returns ====
 
After the execution of an OSClose statement, the Status() of the close is returned with one of the following codes:

^Value^Meaning^
|0|No error.|
|1|Bad OS filename.|
|2|Access denied by operating system.|
|3|Disk or directory full.|
|4|File does not exist.|
|5|Unknown error.|
|6|Attempt to write to a read-only file.|
 
==== See Also ====
 
[[osbread|OSBRead]], [[osbwrite|OSBWrite]], [[osdelete|OSDelete]], [[osopen|OSOpen]], [[osread|OSRead]], [[oswrite|OSWrite]]
 
==== Example ====
 
<code>
/* This code reads an existing OS file and copies it in 100 character chunks to a new OS file */

Equ RECSIZE$ To 100

readOffset = 0

writeOffset = 0

 

filename = "c:\temp\my_data.txt"

newFileName = "c:\temp\my_new_data.txt"

 

oswrite "" To newFileName ; * create the new file

 

OSOpen filename To inputFileHandle then

  OSOpen newFileName To outputFileHandle Then

    Loop

      OSBRead data From inputFileHandle At readOffset length RECSIZE$

      error = status()

    Until data = NULL$

      readOffset += RECSIZE$

      OSBWrite data On outputFileHandle At writeOffset

      writeOffset += RECSIZE$

    Repeat

  end else

    error = status()

  end

End else

  error = status()

End

 

osclose inputFileHandle

osclose outputFileHandle
</code>