Difference between revisions of "NL/Documentation/BASIC Guide/Files and Directories (Runtime Library)"
(→modus Compatibiliteit) |
(→Searching Through Directories) |
||
Line 28: | Line 28: | ||
</source> | </source> | ||
− | === | + | === Zoeken in mappen === |
− | + | De functie <tt>Dir</tt> in {{OOo}} BASIC is verantwoordelijk voor het zoeken door mappen naar bestanden en sub-mappen. Bij het eerste verzoek dient een tekenreeks, die het pad bevat naar de mappen die moeten worden doorzocht, te worden toegewezen aan <tt>Dir</tt> als diens eerste parameter. De tweede parameter van <tt>Dir</tt> specificeert het bestand of de map waarnaar moet worden gezocht. {{OOo}} BASIC geeft de naam weer van de eerste map die wordt gevonden. Om het volgende item te vinden, zou de functie <tt>Dir</tt> moeten worden gevraagd zonder parameters. Als de functie <tt>Dir</tt> geen item meer vindt, geeft het een lege tekenreeks weer. | |
− | + | Het volgende voorbeeld toont hoe de functie <tt>Dir</tt>kan worden gebruikt om alle bestanden, die zich bevinden in één map, kunnen worden opgevraagd. De procedure slaat de individuele bestandsnamen op in de variabele <tt>AlleBestanden</tt> en geeft die dan weer in een berichtenvenster. | |
<source lang="oobas"> | <source lang="oobas"> | ||
− | Sub | + | Sub BestandenTonen |
− | Dim | + | Dim VolgendBestand As String |
− | Dim | + | Dim AlleBestanden As String |
− | + | AlleBestanden = "" | |
− | + | VolgendBestand = Dir("C:\", 0) | |
− | While | + | While VolgendBestand <> "" |
− | + | AlleBestanden = AlleBestanden & Chr(13) & VolgendBestand | |
− | + | VolgendBestand = Dir | |
Wend | Wend | ||
− | MsgBox | + | MsgBox AlleBestanden |
End Sub | End Sub | ||
</source> | </source> | ||
− | + | De <tt>0</tt>, gebruikt in de tweede parameter in de functie <tt>Dir</tt>, zorgt er voor dat <tt>0</tt> alleen de namen van bestanden weergeeft en mappen worden genegeerd. De volgende parameters kunnen hier worden gespecificeerd: | |
− | * <tt>0</tt> : | + | * <tt>0</tt> : geeft normale bestanden weer |
− | * <tt>16</tt> : sub- | + | * <tt>16</tt> : sub-mappen |
− | + | Het volgende voorbeeld is nagenoeg hetzelfde als het voorgaande voorbeeld, maar de functie <tt>Dir</tt> transporteert de waarde 16 als een parameter, welke de sub-mappen van een map weergeven in plaats van de bestandsnamen. | |
<source lang="oobas"> | <source lang="oobas"> | ||
− | Sub | + | Sub MappenTonen |
− | Dim | + | Dim VolgendeMap As String |
− | Dim | + | Dim AlleMappen As String |
− | + | AlleMappen = "" | |
− | + | VolgendeMap = Dir("C:\", 16) | |
− | While | + | While VolgendeMap <> "" |
− | + | AlleMappen = AlleMappen & Chr(13) & VolgendeMap | |
− | + | VolgendeMap = Dir | |
Wend | Wend | ||
− | MsgBox | + | MsgBox AlleMappen |
End Sub | End Sub | ||
</source> | </source> | ||
− | {{Documentation/VBAnote| | + | {{Documentation/VBAnote|Indien gevraagd in {{OOo}} Basic, geeft de functie <tt>Dir</tt>, die de parameter 16 gebruikt, alleen de sub-mappen van een map weer. In VBA geeft de functie ook de namen van de normale bestanden weer zodat nadere controle is vereist om alleen de mappen op te halen. Bij het gebruiken van de functie <tt>CompatibilityMode ( true )</tt> gedraagt {{OOo}} BASIC zich als VBA en de functie Dir, die parameter 16 gebruikt, geeft sub-mappen en namen van normale bestanden weer.}} |
− | {{Documentation/VBAnote| | + | {{Documentation/VBAnote|De in VBA verschafte opties voor het zoeken door mappen, specifiek naar bestanden met de eigenschappen '''verborgen''', '''systeembestand''', '''archief''' en '''volumenaam''', bestaat niet in {{OOo}} BASIC omdat de overeenkomende functies voor het bestandssysteem niet beschikbaar zijn op alle besturingssystemen.}} |
− | {{Documentation/VBAnote| | + | {{Documentation/VBAnote|De specificaties voor het pad zoals vermeld in <tt>Dir</tt> mogen de tijdelijke plaatsaanduidingen * en ? gebruiken in zowel VBA als in {{OOo}} BASIC. In {{OOo}} BASIC kan de tijdelijke plaatsaanduiding * echter slechts het laatste teken van een bestandsnaam en/of bestandsextensie zijn, wat niet het geval is in VBA. }} |
=== Creating and Deleting Directories === | === Creating and Deleting Directories === |
Revision as of 14:23, 26 January 2013
Werken met bestanden is een van de basistaken van een toepassing. De Apache OpenOffice API verschaft een groot scala aan objecten waarmee u kantoordocumenten kunt creëren, openen en aanpassen. Deze worden in detail gepresenteerd in Introductie voor de Apache OpenOffice API. Niettegenstaande dit, in sommige gevallen zult u direct het bestandssysteem moeten benaderen, zoeken in directory's of tekstbestanden bewerken. De runtime bibliotheek van Apache OpenOffice BASIC verschaft verscheidene fundamentele functies voor deze taken.
Beheren van bestanden
modus Compatibiliteit
Het argument en de functie CompatibilityMode verschaffen grotere compatibiliteit met VBA, door de werking van bepaalde functies te wijzigen. Het effect on een bepaalde functie wordt, hieronder, bij die functie beschreven.
Als een argument krijgt CompatibilityMode( waarde ) een Booleaanse waarde om de modus in te stellen of uit te schakelen. Als een functie geeft CompatibilityMode() de Booleaanse waarde van de modus terug.
CompatibilityMode( True ) 'modus instellen CompatibilityMode( False) 'modus uitschakelen Dim bModus as Boolean bModus = CompatibilityMode()
Zoeken in mappen
De functie Dir in Apache OpenOffice BASIC is verantwoordelijk voor het zoeken door mappen naar bestanden en sub-mappen. Bij het eerste verzoek dient een tekenreeks, die het pad bevat naar de mappen die moeten worden doorzocht, te worden toegewezen aan Dir als diens eerste parameter. De tweede parameter van Dir specificeert het bestand of de map waarnaar moet worden gezocht. Apache OpenOffice BASIC geeft de naam weer van de eerste map die wordt gevonden. Om het volgende item te vinden, zou de functie Dir moeten worden gevraagd zonder parameters. Als de functie Dir geen item meer vindt, geeft het een lege tekenreeks weer.
Het volgende voorbeeld toont hoe de functie Dirkan worden gebruikt om alle bestanden, die zich bevinden in één map, kunnen worden opgevraagd. De procedure slaat de individuele bestandsnamen op in de variabele AlleBestanden en geeft die dan weer in een berichtenvenster.
Sub BestandenTonen Dim VolgendBestand As String Dim AlleBestanden As String AlleBestanden = "" VolgendBestand = Dir("C:\", 0) While VolgendBestand <> "" AlleBestanden = AlleBestanden & Chr(13) & VolgendBestand VolgendBestand = Dir Wend MsgBox AlleBestanden End Sub
De 0, gebruikt in de tweede parameter in de functie Dir, zorgt er voor dat 0 alleen de namen van bestanden weergeeft en mappen worden genegeerd. De volgende parameters kunnen hier worden gespecificeerd:
- 0 : geeft normale bestanden weer
- 16 : sub-mappen
Het volgende voorbeeld is nagenoeg hetzelfde als het voorgaande voorbeeld, maar de functie Dir transporteert de waarde 16 als een parameter, welke de sub-mappen van een map weergeven in plaats van de bestandsnamen.
Sub MappenTonen Dim VolgendeMap As String Dim AlleMappen As String AlleMappen = "" VolgendeMap = Dir("C:\", 16) While VolgendeMap <> "" AlleMappen = AlleMappen & Chr(13) & VolgendeMap VolgendeMap = Dir Wend MsgBox AlleMappen End Sub
Creating and Deleting Directories
Apache OpenOffice Basic provides the MkDir function for creating directories.
MkDir ("C:\SubDir1")
This function creates directories and sub-directories. All directories needed within a hierarchy are also created, if required. For example, if only the C:\SubDir1 directory exists, then a call
MkDir ("C:\SubDir1\SubDir2\SubDir3\")
creates both the C:\SubDir1\SubDir2 directory and the C:\SubDir1\SubDir2\SubDir3 directory.
The RmDir function deletes directories.
RmDir ("C:\SubDir1\SubDir2\SubDir3\")
If the directory contains sub-directories or files, these are also deleted. You should therefore be careful when using RmDir.
VBA : In VBA, the MkDir and RmDir functions only relate to the current directory. In Apache OpenOffice Basic on the other hand, MkDir and RmDir can be used to create or delete levels of directories. |
Copying, Renaming, Deleting and Checking the Existence of Files
The following call creates a copy of the Source file under the name of Destination:
FileCopy(Source, Destination)
With the help of the following function you can rename the OldName file with NewName. The As keyword syntax, and the fact that a comma is not used, goes back to the roots of the Basic language.
Name OldName As NewName
The following call deletes the Filename file. If you want to delete directory (including its files) use the RmDir function.
Kill(Filename)
The FileExists function can be used to check whether a file exists:
If FileExists(Filename) Then MsgBox "file exists." End If
Reading and Changing File Properties
When working with files, it is sometimes important to be able to establish the file properties, the time the file was last changed and the length of the file.
The following call returns some properties about a file.
Dim Attr As Integer Attr = GetAttr(Filename)
The return value is provided as a bit mask in which the following values are possible:
- 1 : read-only file
- 16 : name of a directory
The following example determines the bit mask of the test.txt file and checks whether this is read-only whether it is a directory. If neither of these apply, FileDescription is assigned the "normal" string.
Dim FileMask As Integer Dim FileDescription As String FileMask = GetAttr("test.txt") If (FileMask AND 1) > 0 Then FileDescription = FileDescription & " read-only " End IF If (FileMask AND 16) > 0 Then FileDescription = FileDescription & " directory " End IF If FileDescription = "" Then FileDescription = " normal " End IF MsgBox FileDescription
The SetAttr function permits the properties of a file to be changed. The following call can therefore be used to provide a file with read-only status:
SetAttr("test.txt", 1)
An existing read-only status can be deleted with the following call:
SetAttr("test.txt", 0)
The date and time of the last amendment to a file are provided by the FileDateTime function. The date is formatted here in accordance with the country-specific settings used on the system.
FileDateTime("test.txt") ' Provides date and time of the last file amendment.
The FileLen function determines the length of a file in bytes (as long integer value).
FileLen("test.txt") ' Provides the length of the file in bytes
Writing and Reading Text Files
Apache OpenOffice Basic provides a whole range of methods for reading and writing files. The following explanations relate to working with text files (not text documents).
Writing Text Files
Before a text file is accessed, it must first be opened. To do this, a free file handle is needed, which clearly identifies the file for subsequent file access.
The FreeFile function is used to create a free file handle:
FileNo = FreeFile
FileNo is an integer variable that receives the file handle. The handle is then used as a parameter for the Open instruction, which opens the file.
To open a file so that it can be written as a text file, the Open call is:
Open Filename For Output As #FileNo
Filename is a string containing the name of the file. FileNo is the handle created by the FreeFile function.
Once the file is opened, the Print instruction can create the file contents, line by line:
Print #FileNo, "This is a test line."
FileNo also stands for the file handle here. The second parameter specifies the text that is to be saved as a line of the text file.
Once the writing process has been completed, the file must be closed using a Close call:
Close #FileNo
Again here, the file handle should be specified.
The following example shows how a text file is opened, written, and closed:
Dim FileNo As Integer Dim CurrentLine As String Dim Filename As String Filename = "c:\data.txt" ' Define file name FileNo = FreeFile ' Establish free file handle Open Filename For Output As #FileNo ' Open file (writing mode) Print #FileNo, "This is a line of text" ' Save line Print #FileNo, "This is another line of text" ' Save line Close #FileNo ' Close file
Reading Text Files
Text files are read in the same way that they are written. The Open instruction used to open the file contains the For Input expression in place of the For Output expression and, rather than the Print command for writing data, the Line Input instruction should be used to read the data.
Finally, when calling up a text file, the eof instruction is used to check whether the end of the file has been reached:
eof(FileNo)
The following example shows how a text file can be read:
Dim FileNo As Integer Dim CurrentLine As String Dim File As String Dim Msg as String ' Define filename Filename = "c:\data.txt" ' Establish free file handle FileNo = Freefile ' Open file (reading mode) Open Filename For Input As FileNo ' Check whether file end has been reached Do While not eof(FileNo) ' Read line Line Input #FileNo, CurrentLine If CurrentLine <>"" then Msg = Msg & CurrentLine & Chr(13) end if Loop ' Close file Close #FileNo Msgbox Msg
The individual lines are retrieved in a Do While loop, saved in the Msg variable, and displayed at the end in a message box.
Content on this page is licensed under the Public Documentation License (PDL). |