--- title: "BinaryFile (_BinaryFile class)" canonical: "https://docs.cuesystem.com/space/CVCHELP/510591213/BinaryFile%20(_BinaryFile%20class)" format: markdown --- > Macro (toc) --- # Close  This function closes the file for that instance _BinaryFile. Over a closed file cannot perform any functions except Open. See examples.  #### Syntax  ```visualbasic Function Close() ``` # Copy  This function copies the current contents of an opened file to the destination file. If the destination file does not exist, it is automatically created. If it exists and the parameter eraseexisting is false, then the copy will fail. See examples.  The function [GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError) returns the error number that occurred while executing the command. The errors that can happen: [78](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#78), [103](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#103), [104](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#104), [105](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#105), [106](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#106), [107](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#107), [108](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#108), [109](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#109), [110](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#110).  #### Syntax  ```visualbasic Function Copy(  destinationfilepathname As Text,  Optional eraseexisting As Boolean := True)  As Boolean ``` #### Parameters  destinationfilepathname  [Text](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Text) It is the pathname of the destination file. See [rules of names of files and folders](/wiki/spaces/CVCHELP/pages/512983041/Files+folders#NamesOfFilesAndFolders).  eraseexisting  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Optional, defaults to True. If it is True, the existing file is erased.  #### Return value  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True on success or False if an error occurs. The function GetLastError returns the error number.  # EraseContent  This function deleted file contents. See examples.  The function [GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError) returns the error number that occurred while executing the command. The errors that can happen: [78](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#78), [102](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#102), [103](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#103).  #### Syntax* * ```visualbasic Function EraseContent() As Boolean ``` #### Return value  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True on success or False if an error occurs. The function GetLastError returns the error number.  # GetPathName  This function returns the path to an opened file in its entirety, including the directory name. See examples.  The function [GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError) returns the error number that occurred while executing the command. The errors that can happen: [78](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#78), [80](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#80), [103](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#103).  #### Syntax  ```visualbasic Function GetPathName(ByRef filepath As Text) As Boolean ``` #### Parameters  filepath  [Text](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Text) It is the pathname of the destination file.  #### Return value  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True on success or False if an error occurs. The function GetLastError returns the error number.  # Open  This function opens a file in reading and write mode and sets the position to start. The file is always opened exclusively. If the file does not exist, it is automatically created. If there is no directory structure, it is automatically created. See examples.  The function [GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError) returns the error number that occurred while executing the command. The errors that can happen: [77](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#77), [79](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#79), [103](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#103), [108](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#108), [109](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#109), [110](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#110), [111](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#111), [119](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#119).  #### Syntax  ```visualbasic Function Open(filepathname As Text) As Boolean ``` #### Parameters  filepathname  [Text](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Text) It is the pathname of the file. See [rules of names of files and folders](/wiki/spaces/CVCHELP/pages/512983041/Files+folders#NamesOfFilesAndFolders).  #### Return value  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True on success or False if an error occurs. The function GetLastError returns the error number.  # OpenReadOnly  This function opens a file in read-only mode and sets the position to start. If the file does not exist, one is not created and the function returns False. See examples.  The function [GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError) returns the error number that occurred while executing the command. The errors that can happen: [77](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#77), [79](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#79), [103](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#103), [108](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#108), [109](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#109), [110](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#110), [111](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#111), [119](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#119).  #### Syntax  ```visualbasic Function Open(filepathname As Text) As Boolean ``` #### Parameters  filepathname  [Text](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Text) It is the pathname of the file. See [rules of names of files and folders](/wiki/spaces/CVCHELP/pages/512983041/Files+folders#NamesOfFilesAndFolders).  #### Return value  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True on success or False if an error occurs. The function GetLastError returns the error number.  # Read  This function reads the optional number of bytes from a file. A file position is shifted by the number of bytes read. If the specified number of bytes numofbytes = 0, then reads as many bytes as there is capacity destinationbytestring. When the end of the file is reached False is returned. If reading fails for other reasons, False is returned.  See examples.  The function [GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError) returns the error number that occurred while executing the command. The errors that can happen: [78](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#78), [103](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#103), [112](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#112).  #### Syntax  ```visualbasic Function Read(  ByRef destinationbytestring As ByteString,  Optional numofbytes As Long := 0)  As Boolean ``` #### Parameters  destinationbytestring  [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) It is the destination bytestring.  numofbytes  [Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Optional, defaults to 0. It is the number of bytes to read. If it is 0, then reads as many bytes as there is a capacity destinationbytestring.  #### Return value  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True on success or False if an error occurs. The function GetLastError returns the error number.  # Write  This function writes the value of the source bytestring at end of the file. See examples.  The function [GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError) returns the error number that occurred while executing the command. The errors that can happen: [78](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#78), [103](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#103), [115](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#115).  #### Syntax  ```visualbasic Function Write(sourcebytestring As ByteString) As Boolean ``` #### Parameters  sourcebytestring  [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) It is the bytestring to write.  #### Return value  [Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True on success or False if an error occurs. The function GetLastError returns the error number.  # Examples  #### Reading/writing text data  ```visualbasic Var CfgBinaryFile As _BinaryFile  Var CfgData As ByteString[100]  If CfgBinaryFile.Open("/filestorage/cfg.txt") Then  CfgBinaryFile.EraseContent()  CfgBinaryFile.Write(&S"Hello, how are you?")  CfgBinaryFile.Close()  End If  If CfgBinaryFile.Open("/filestorage/cfg.txt") Then  CfgBinaryFile.Read(CfgData)  CfgBinaryFile.Close()  End If ``` #### Copy  ```visualbasic Var CfgBinaryFile As _BinaryFile  If CfgBinaryFile.Open("/filestorage/cfg.txt") Then  CfgBinaryFile.Copy("/filestorage/cfg2.txt")  CfgBinaryFile.Close()  End If ``` #### GetPathName  ```visualbasic Var CfgBinaryFile As _BinaryFile  Var FilePath As Text[100]  If CfgBinaryFile.Open("/filestorage/cfg.txt") Then  CfgBinaryFile.GetPathName(FilePath)  CfgBinaryFile.Close()  End If ```