Otwierania i zamykanie plików
Pierwszą ważną funkcją jest FileOpen, powoduje ona otwarcie pliku tekstowego. Otwarcie pliku jest konieczne aby można było czytać z pliku lub do niego zapisywać.
FileOpen FileOpen ( "nazwa_pliku" [, mode ] ) Funkcja zwraca uchwyt do pliku lub -1 gdy otwarcie pliku nie powiodło się.
Uchwyt jest to liczbowy identyfikator, którego możemy używać zamiast nazwy pliku (łącznie ze ścieżką dostępu). Operowanie uchwytami jest o wiele szybsze niż nazwami plików.
Funkcja ta ma dwa parametry:
"nazwa_pliku" - nazwa otwieranego pliku, może być ze ścieżką dostępu
Drugi parametr jest opcjonalny tzn. że może być pominięty jeżeli odpowiada nam jego wartość domyślna:
mode - określa sposób otwarcia pliku
0 - otwiera plik tylko do odczytu, jeżeli plik nie istnieje nie jest tworzony (wartość domyślna)
1 - otwiera plik do zapisu, dopisywanie na końcu pliku, jeżeli plik nie istnieje jest tworzony
2 - usuwa poprzednią zawartość pliku i otwiera go do zapisu, jeżeli plik nie istnieje jest tworzony
4 - odczytuje plik w trybie RAW (odczyt i zapis)
Dodanie wartości 8 spowoduje utworzenie struktury folderów, o ile te nie istnieją.
Przykład: $hFile = FileOpen("C:\Windows\tymczasowy\Test.txt",9) ;1+8 otwiera plik do zapisu ;jeżeli nie istnieje zostanie utworzony wraz z katalogiem
Kolejną funkcją jest:
FileClose FileClose (uchwyt) Zamyka ona uprzednio otwarty plik. Jedynym jej parametrem jest uchwyt do pliku, odczytany funkcją FileOpen.
Funkcja zwraca 1 gdy operacja zakończyła się sukcesem, lub 0 gdy wystąpił błąd.
Przykład: $hFile = FileOpen("C:\Windows\tymczasowy\Test.txt",9) FileClose($hFile) Zamykanie plików jest bardzo ważne, pozwala oszczędzić trochę pamięć komputera.
Zapis do plików
Pierwszą funkcją która zapisuje dane do pliku jest:
FileWrite FileWrite ( uchwyt|"nazwa_pliku", dane ) Funkcja dopisuje dane na końcu pliku. Zwraca 1 gdy sukces lub 0 gdy wystąpił błąd.
Parametry:
uchwyt|"nazwa_pliku" - uchwyt do pliku lub jego nazwa
dane - dopisywane dane (tekstowe lub binarne)
Przykład: $hFile = FileOpen("Test.txt",1) FileWrite($hFile, "Jakiś tekst") FileClose($hFile) Po uruchomieniu tego skryptu w katalogu roboczym zostanie utworzony plik Test.txt (jeżeli nie istnieje), zaś w nim tekst "Jakiś tekst". Oczywiście zamiast nazwy pliku można podać pełną ścieżkę, wtedy plik zostanie utworzony w opisanej tą ścieżką lokacji.
Istnieje pewna istotna różnica między użyciem uchwytu, a użyciem nazwy pliku. Uchwytu można użyć tylko gdy plik został uprzednio otwarty, natomiast podanie nazwy pliku powoduje automatyczne otwarcie pliku, a po zakończeniu zapisu jego zamknięcie. Wydawało by się, że druga metoda jest prostsza, ale nie zawsze jest optymalna (patrz poniższy przykład).
FileWrite zapisuje dane ciągiem, aby zaznaczyć koniec linii musimy dopisać @CRLF. FileWrite("Test.txt", "Jakiś tekst") FileWrite("Test.txt", @CRLF) ; Koniec linii FileWrite("Test.txt", "Jakiś tekst 2") ;już w nowej linii lub z użyciem uchwytów: $hFile = FileOpen("Test.txt",2) FileWrite($hFile, "Jakiś tekst") FileWrite($hFile, @CRLF) ; Koniec linii FileWrite($hFile, "Jakiś tekst 2") ;już w nowej linii FileClose($hFile) W pierwszym przykładzie plik będzie otwierany i zamykany 3 razy, w drugim tylko raz. Użycie uchwytu wprawdzie wydłużyło skrypt o 2 linie, ale skróciło czas jego wykonywania.
Ma to szczególnie znaczenie przy skomplikowanej edycji dużych plików tekstowych.
Drugą funkcją zapisującą dane do pliku jest FileWriteLine. Ta funkcja różni się od poprzedniej tym, że zawsze dopisuje dane od nowej linii, oraz że nie stosuje się jej do plików binarnych:
FileWriteLine FileWriteLine ( uchwyt|"nazwa_pliku", "linia" )
Dodaje linię tekstu na końcu wcześniej otwartego pliku tekstowego.
Parametry:
uchwyt|"nazwa_pliku" - uchwyt do pliku lub jego nazwa,
"linia" - Wiersz tekstu do zapisania w pliku tekstowym. Jeśli linia NIE kończy się na @CR lub @LF, to automatycznie zostanie dodane @CRLF.
Przykład: FileWriteLine("Test.txt", "Jakiś tekst") FileWriteLine("Test.txt", "Jakiś tekst 2")
Funkcje FileWrite i FileWriteLine nie zapisują danych bezpośrednio na fizycznym dysku, lecz operacje tą wykonują w buforze pamięci operacyjnej. Rzeczywisty zapis odbywa się dopiero w momencie zamknięcia pliku. Jeżeli jednak po zapisaniu pliku chcemy go odczytać bez zamykania, musimy bufor zrzucić na fizyczny dysk. Służy do tego funkcja:
FileFlush FileFlush ( "uchwyt" ) Funkcja zwraca True gdy bufor został zrzucony na dysk, lub 0 gdy wystąpił błąd.
uchwyt - uchwyt do pliku
Czytanie z plików
FileRead FileRead ( uchwyt|"nazwa_pliku" [, count] ) Funkcja zwraca wczytane dane tekstowe lub binarne. Opcjonalny parametr count określa ile znaków (bajtów) ma być wczytane.
Przykład: MsgBox(0, "Test", FileRead("Test.txt",5)) ;zostanie odczytanych pierwszych 5 znaków
Drugie polecenie służy do odczytania z pliku tekstowego wybranej linii tekstu:
FileReadLine FileReadLine ( uchwyt|"nazwa_pliku" [, nr_linii] ) nr_linii - numer wczytywanej linii tekstu, wartość domyślna to 1, -1 oznacza ostatnią linię
Przykład: MsgBox(0, "Test", FileReadLine("Test.txt",2)) ;zostanie wczytany drugi wiersz tekstu
FileReadToArray FileReadToArray ( uchwyt|"nazwa_pliku" ) Funkcja odczytuje plik tekstowy i zapisuje go do jednowymiarowej tablicy. Wiersze pliku są zapisywane w kolejnych komórkach tablicy, która jest zwracana przez funkcję. Jeżeli wystąpił błąd ustawiana jest wartość makra @error (1 - błąd otwierania pliku, 2 - plik jest pusty).
Przykład: ;wczytanie do tablicy pliku zawierającego wykonywany skrypt $aArray = FileReadToArray(@ScriptFullPath)
If @error Then MsgBox(0, "", "Wystąpił błąd. @error: " & @error) Else For $i = 0 To UBound($aArray) - 1 ; Loop through the array. MsgBox(0, "Wiersz: " & $i+1, $aArray[$i]) Next EndIf
Wskaźnik pozycji w pliku Zapis i czytanie danych z pliku rozpoczyna się od pozycji wskaźnika. Funkcja FileOpen ustawia wskaźnik na początku pliku, a FileReadLine na jego końcu.
Jest jednak możliwość przeniesienia wskaźnika w dowolne miejsce pliku. Dzięki temu operacje zapisu i odczytu mogą się rozpoczynać w dowolnym miejscu pliku, a nie tylko standardowo od początku lub na końcu. Służy do tego funkcja:
FileSetPos FileSetPos ( uchwyt, offset, start ) Funkcja zwraca True gdy sukces, lub 0 gdy wystąpił błąd.
uchwyt - uchwyt do pliku
offset - przesunięcie względem pozycji startowej w kierunku końca pliku (może być także liczbą ujemną dla start 1 lub 2, wartość ujemna oznacza przesunięcie w kierunku początku pliku)
start - pozycja startowa:
0 - początek pliku
1 - aktualna pozycja wskaźnika
2 - koniec pliku
Aby poznać aktualną pozycję wskaźnika należy użyć funkcji:
FileGetPos FileGetPos ( uchwyt ) Funkcja zwraca pozycję wskaźnika, jeżeli wystąpi błąd to zwraca 0 i makro @error przyjmuje wartość 1.
uchwyt - uchwyt do pliku
UWAGA: Ponieważ indeksy pozycji rozpoczynają się od 0 (wskaźnik na początku pliku), to zwrócona wartość równa 0 oznacza błąd tylko w przypadku gdy jednocześnie makro @error jest różne od zera.
Przykład: $sFile = "test.txt" ;utworzenie pliku testowego $hFile = FileOpen($sFile, 2)
;obsługa ewentualnych błędów If $hFile = -1 Then MsgBox(0, "Błąd:", "Nie można otworzyć pliku.") Exit EndIf
;zapis wierszy w pliku testowym FileWriteLine($hFile, "Wiersz 1") FileWriteLine($hFile, "Wiersz 2") FileWriteLine($hFile, "Wiersz 3")
;zrzucenie bufora pliku na dysk FileFlush($hFile)
;odczytanie aktualnej pozycji i odczyt danych rozpoczynając od niej MsgBox(0, "", "Pozycja: " & FileGetPos($hFile) & @CRLF & "Dane: " & @CRLF & FileRead($hFile))
;ustawienie wskaźnika na początku pliku FileSetPos($hFile, 0, 0) MsgBox(0, "", "Pozycja: " & FileGetPos($hFile) & @CRLF & "Dane: " & @CRLF & FileRead($hFile))
;ustawienie wskaźnika na 10 pozycji FileSetPos($hFile, 10, 0)
;zapis wiersza od ustalonej pozycji FileWriteLine($hFile, "%%%") FileFlush($hFile)
FileSetPos($hFile, 0, 0)
MsgBox(0, "", "Pozycja: " & FileGetPos($hFile) & @CRLF & "Dane: " & @CRLF & FileRead($hFile))
;zamknięcie pliku FileClose($hFile)
;usunięcie pliku testowego FileDelete($sFile)
FileSetEnd FileSetEnd ( uchwyt ) Funkcja ustawia koniec pliku na bieżącym położeniu wskaźnika. Zwraca True gdy sukces, lub False gdy wystąpił błąd.
uchwyt - uchwyt do pliku
Szukanie plików / folderów
FileFindFirstFile FileFindFirstFile ( "nazwa_pliku" ) Funkcja zwraca uchwyt dla funkcji FileFindNextFile, lub -1 gdy nie znaleziono pliku / folderu (makro @error przyjmuje wartość 1).
"nazwa_pliku" - nazwa poszukiwanego pliku (plików), wielkość liter jest ignorowana. Akceptowane są symbole wieloznaczne (wildcards) * i ?, można użyć tylko jednego symbolu wieloznacznego w części pliku lub w części rozszerzenie np.: *. b?.
FileFindNextFile FileFindNextFile ( search ) Funkcja zwraca kolejne nazwy plików spełniających warunki określone w FileFindFirstFile. Makro @extended przyjmuje wartość 1 gdy nazwa jest nazwą folderu, a nie pliku.
Jeżeli nie ma już plików / folderów o nazwach spełniających określone warunki, makro @error przyjmuje wartość 1.
serch - uchwyt zwracany przez funkcję FileFindFirstFile.
UWAGA: Po zakończeni przeszukiwania należy wywołać funkcji FileClose() celem zwolnienia uchwytu.
Przykład: $sMask = @WindowsDir&"/*.bmp" ;pliki z rozszerzeniem BMP w katalogu windows $hSearch = FileFindFirstFile($sMask) If $hSearch = -1 Then MsgBox(0, $sMask, "Brak plików!") Exit EndIf
Do $hFile = FileFindNextFile($hSearch) If @error Then MsgBox(0, "Znalezione pliki:", "Nie ma więcej plików", 3) Exit EndIf Until MsgBox(1, "Znalezione pliki:", $hFile)=2 FileClose($hSearch)
FileExists FileExists ( "path" ) Funkcja sprawdza czy istnieje dany plik lub folder. Jeżeli tak to zwraca 1, w przeciwnym razie 0.
"path" - ścieżka pliku lub folderu
Przykład: MsgBox(0, "Test", FileExists("c:\windows\")) ;czy istnieje folder MsgBox(0, "Test", FileExists("test.txt")) ;czy istnieje plik, sprawdzanie w folderze bieżącym
Usuwanie pliku (plików)
FileDelete FileDelete ( "path" ) Funkcja zwraca 1 gdy sukces, 0 gdy wystąpił błąd lub plik (folder) nie istnieje.
"path" - nazwa i ścieżka dostępu pliku do usunięcia (można stosować wieloznaczniki "*" i "?" (ang. Wildcards))
Przykład: MsgBox(0, "Test", FileDelete("*.tmp"))
FileRecycle FileRecycle ( "źródło" ) Funkcja przenosi plik lub folder do kosza systemowego. Zwraca 1 gdy sukces, 0 gdy wystąpił błąd lub plik (folder) nie istnieje.
"źródło" - nazwa i ścieżka dostępu pliku źródłowego (można stosować wieloznaczniki "*" i "?" (ang. Wildcards))
Przykład: MsgBox(0, "Test", FileRecycle("test.txt"))
FileRecycleEmpty FileRecycleEmpty ( ["źródło"] ) Funkcja powoduje opróżnienie kosza systemowego (trwale usuwa z niego wszystkie pliki). Zwraca 1 gdy sukces, lub 0 gdy kosz nie może zostać opróżniony.
"źródło" - parametr opcjonalny określający, z którego dysku kosz ma być opróżniony (pominięcie parametru powoduje opróżnienie koszy na wszystkich dyskach)
UWAGA: - Aby funkcja działała konieczny jest IE przynajmniej w wersji 4.
Przykład: FileRecycleEmpty("C:\")
Kopiowanie i przenoszenie wskazanego pliku (plików)
FileCopy FileCopy ( "źródło", "cel" [, flag] ) Funkcja kopije wskazany plik (pliki). Zwraca 1 gdy sukces, 0 gdy wystąpił błąd.
Parametry:
"źródło" - nazwa i ścieżka dostępu pliku źródłowego (można stosować wieloznaczniki "*" i "?" (ang. Wildcards))
"cel" - ścieżka docelowa kopiowanych plików
Parametr opcjonalny:
flag - określa sposób zapisu pliku docelowego
0 - istniejące pliki nie są nadpisywane (domyślne)
1 - pliki są nadpisywane
Dodanie wartości 8 spowoduje utworzenie struktury folderów, o ile te nie istnieją.
Przykład (skopiowanie wszystkich plików z rozszerzeniem txt z folderu "old" na dysku C, do folderu "new" na dysku D): FileCopy("c:\old\*.txt", "d:\new\")
FileMove FileMove ( "źródło", "cel" [, flag] ) Funkcja przenosi wskazany plik (pliki). Zwraca 1 gdy sukces, 0 gdy wystąpił błąd.
Parametry: