ScriptForge.FileSystem service

Tjenesten FileSystem inkluderer rutiner for å håndtere filer og mapper. Deretter følger noen eksempler på funksjonene som tilbys av denne tjenesten:

• Kontroller om det finnes en fil eller mappe.

• Opprett og slett mapper og filer.

• Start dialogbokser for å åpne/lagre filer.

• Få tilgang til listen over filer i en mappe osv.

The methods in the FileSystem service are mostly based on the XSimpleFileAccess UNO interface.

Definisjoner

Tabellen nedenfor viser hovedparametrene som brukes av de fleste metodene i FileSystem-tjenesten.

Tjenesten FileSystem gjør det mulig å utføre operasjoner over flere filer samtidig. Ved å bruke navnemønstre kan brukerskript kopiere, flytte eller slette flere filer. Omvendt kan grunnleggende innebygde metoder bare håndtere enkeltfiler.

Filnavnnotasjon

Notasjonen som brukes til å uttrykke fil- og mappenavn, både for argumenter og returnerte verdier, er definert av egenskapen FileName til FileSystem-tjenesten.

In short, the possible representation types are "URL" (URL file notation), "SYS" (operating system notation) and "ANY" (default). See more information below.

Et eksempel på URL-notasjonen er file:///C:/Documents/my_file.odt. Når det er mulig, bør du vurdere å bruke URL-notasjonen fordi det er et mer bærbart alternativ.

Bruken av snarveien "~" (tilde), som er vanlig i Linux-baserte operativsystemer, støttes ikke for å uttrykke en bane til en mappe og et filnavn. I stedet for å bruke "~/Documents/my_file.odt", bruk hele stien "/home/user/Documents/my_file.odt".

Tjenestepåkallelse

Følgende kodebit starter FileSystem-tjenesten. Metoden BuildPath ble brukt som eksempel.

      GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
      Dim FSO As Object
      Set FSO = CreateScriptService("FileSystem")
      FSO.BuildPath(...)
    

      from scriptforge import CreateScriptService
      fso = CreateScriptService("FileSystem")
      fso.BuildPath(...)
    

Egenskaper

BuildPath

Kobler sammen en mappesti og navnet på en fil og returnerer hele filnavnet med en gyldig stiseparator. Stiskilleren legges bare til hvis nødvendig.

svc.BuildPath(foldername: str, name: str): str

mappenavn: Stien og navnet vil bli kombinert med. Den angitte stien trenger ikke å være en eksisterende mappe.

navn: Navnet på filen som skal legges til mappenavn. Denne parameteren bruker notasjonen til gjeldende operativsystem.

      Dim FSO as Object
      Set FSO = CreateScriptService("FileSystem")
      Dim aFileName as String
      FSO.FileNaming = "URL"
      aFileName = FSO.BuildPath("file:///home/user", "sample file.odt")
      ' file:///home/user/sample%20file.odt
    

      fso = CreateScriptService("FileSystem")
      fso.FileNaming = "URL"
      aFileName = fso.BuildPath("file:///home/user", "sample file.odt")
      # file:///home/user/sample%20file.odt
    

CompareFiles

Sammenligner to filer og returnerer True når de virker identiske.

Avhengig av verdien av comparecontents-argumentet, kan sammenligningen mellom begge filene enten være basert på filattributter (som den siste endringsdatoen), eller basert på filinnholdet.

svc.CompareFiles(filename1: str, filename2: str, comparecontents: bool = False): bool

filnavn1, filnavn2: Filene som skal sammenlignes.

comparecontents: Når Sann, sammenlignes innholdet i filene (standard = Usann).

      FSO.FileNaming = "SYS"
      If FSO.CompareFiles("C:\myFile1.txt", "C:\myFile2.txt", CompareContents := False) Then
          ' ...
      End If
    

      fso.FileNaming = "SYS"
      if fso.CompareFiles(r"C:\myFile1.txt", r"C:\myFile2.txt", comparecontents = False):
          # ...
    

CopyFile

Kopierer én eller flere filer fra ett sted til et annet. Returnerer Sann hvis minst én fil har blitt kopiert eller Usann hvis det oppstod en feil.

En feil vil også oppstå hvis parameteren kilde bruker jokertegn og ikke samsvarer med noen filer.

Metoden stopper umiddelbart etter at den støter på en feil. Metoden ruller ikke tilbake og angrer heller ikke endringer som ble gjort før feilen oppsto.

svc.CopyFile(source: str, destination: str, overwrite: bool = True): bool

kilde: Det kan være et Filnavn eller et Navnemønster som indikerer en eller flere filer som skal kopieres.

destinasjon: Det kan enten være et Filnavn som spesifiserer hvor den enkelte kilde-filen skal kopieres, eller et FolderName som de flere filene fra kilde skal kopieres til.

• Hvis destinasjon ikke eksisterer, blir den opprettet.

• Jokertegn er ikke tillatt i destinasjon.

overskriv: Hvis Sann (standard), kan filer bli overskrevet. Metoden vil mislykkes hvis destinasjon er skrivebeskyttet, uavhengig av verdien spesifisert i overskriv.

I eksemplene nedenfor kopierer den første linjen en enkelt fil, mens den andre linjen kopierer flere filer med jokertegn.

      FSO.CopyFile("C:\Documents\my_file.odt", "C:\Temp\copied_file.odt")
      FSO.CopyFile("C:\Documents\*.*", "C:\Temp\", Overwrite := False)
    

      fso.CopyFile(r"C:\Documents\my_file.odt", r"C:\Temp\copied_file.odt")
      fso.CopyFile(r"C:\Documents\*.*", r"C:\Temp", overwrite = False)
    

Beware that subfolders and their contents are not copied when wildcards are used in the source argument.

CopyFolder

Kopierer en eller flere mapper fra ett sted til et annet. Returnerer True hvis minst én mappe har blitt kopiert eller Usann hvis det oppstod en feil.

En feil vil også oppstå hvis parameteren kilde bruker jokertegn og ikke samsvarer med noen mapper.

Metoden stopper umiddelbart etter at den støter på en feil. Metoden ruller ikke tilbake og angrer heller ikke endringer som ble gjort før feilen oppsto.

svc.CopyFolder(source: str, destination: str, overwrite: bool = True): bool

kilde: Det kan være et FolderName eller et NamePattern som indikerer at en eller flere mapper skal kopieres.

destinasjon: Spesifiserer FolderName som enkelt eller flere mapper definert i kilde skal kopieres til.

• Hvis destinasjon ikke eksisterer, blir den opprettet.

• Jokertegn er ikke tillatt i destinasjon.

overskriv: Hvis True (standard), kan filer bli overskrevet. Metoden vil mislykkes hvis destinasjon er skrivebeskyttet, uavhengig av verdien spesifisert i overskriv.

I eksemplene nedenfor er alle filer, mapper og undermapper kopiert.

      ' Basic
      FSO.CopyFolder("C:\Documents\*", "C:\Temp\", Overwrite := False)
    

      # Python
      fso.CopyFolder(r"C:\Documents\*", r"C:\Temp", overwrite = False)
    

CreateFolder

Oppretter det angitte mappenavnet. Returnerer True hvis mappen kunne opprettes.

Hvis den angitte mappen har en overordnet mappe som ikke eksisterer, opprettes den.

svc.CreateFolder(foldername: str): bool

mappenavn: En streng som representerer mappen som skal opprettes. Hvis mappen allerede eksisterer, vil det bli et unntak.

      ' Basic
      FSO.CreateFolder("C:\NewFolder")
    

      # Python
      fso.CreateFolder(r"C:\NewFolder")
    

CreateTextFile

Oppretter en spesifisert fil og returnerer en TextStream tjenesteforekomst som kan brukes til å skrive til filen.

Metoden returnerer et Null-objekt hvis det oppstod en feil.

svc.CreateTextFile(filename: str, overwrite: bool = True, encoding: str = 'UTF-8'): svc

filnavn: Navnet på filen som skal opprettes.

overskriv: Boolsk verdi som bestemmer om filnavn kan overskrives (standard = Sann).

koding: Tegnsettet som skal brukes. Standardkodingen er "UTF-8".

      Dim myFile As Object
      FSO.FileNaming = "SYS"
      Set myFile = FSO.CreateTextFile("C:\Temp\ThisFile.txt", Overwrite := True)
    

      fso.FileNaming = "SYS"
      myFile = fso.CreateTextFile(r"C:\Temp\ThisFile.txt", overwrite = True)
    

To learn more about the names of character sets, visit IANA's Character Set page. Beware that Collabora Office does not implement all existing character sets.

DeleteFile

Sletter én eller flere filer. Returnerer True hvis minst én fil er slettet eller Usann hvis det oppstod en feil.

En feil vil også oppstå hvis parameteren filnavn bruker jokertegn og ikke samsvarer med noen filer.

Filene som skal slettes kan ikke være skrivebeskyttede.

Metoden stopper umiddelbart etter at den støter på en feil. Metoden ruller ikke tilbake og angrer heller ikke endringer som ble gjort før feilen oppsto.

svc.DeleteFile(filename: str): bool

filnavn: Det kan være et Filnavn eller et navnemønster som indikerer en eller flere filer som skal slettes.

I eksemplene nedenfor slettes bare filer, undermapper slettes ikke.

      ' Basic
      FSO.DeleteFile("C:\Temp\*.docx")
    

      # Python
      fso.DeleteFile(r"C:\Temp\*.docx")
    

DeleteFolder

Sletter én eller flere mapper. Returnerer Sann hvis minst én mappe er slettet eller Usann hvis det oppstod en feil.

En feil vil også oppstå hvis parameteren mappenavn bruker jokertegn og ikke samsvarer med noen mapper.

Mappene som skal slettes kan ikke være skrivebeskyttet.

Metoden stopper umiddelbart etter at den støter på en feil. Metoden ruller ikke tilbake og angrer heller ikke endringer som ble gjort før feilen oppsto.

svc.DeleteFolder(foldername: str): bool

mappenavn: Det kan være et Mappenavn eller et Navnemønster som indikerer en eller flere mapper som skal slettes.

I eksemplene nedenfor slettes bare mapper og deres innhold. Filer i den overordnede mappen "C:\Temp" blir ikke slettet.

      ' Basic
      FSO.DeleteFolder("C:\Temp\*")
    

      # Python
      fso.DeleteFolder(r"C:\Temp\*")
    

FileExists

Returnerer Sann hvis et gitt filnavn er gyldig og eksisterer, ellers returnerer metoden Usann.

Hvis parameteren filnavn faktisk er et eksisterende mappenavn, returnerer metoden Usann.

svc.FileExists(filename: str): bool

filnavn: En streng som representerer filen som skal testes.

      FSO.FileNaming = "SYS"
      If FSO.FileExists("C:\Documents\my_file.odt") Then
          '...
      End If
    

      fso.FileNaming = "SYS"
      if fso.FileExists(r"C:\Documents\my_file.odt"):
          # ...
    

Files

Returnerer en null-basert matrise av filene som er lagret i en gitt mappe. Hver oppføring i matrisen er en streng som inneholder hele banen og filnavnet.

Hvis argumentet mappenavn spesifiserer en mappe som ikke eksisterer, oppstår et unntak.

Den resulterende listen kan filtreres med jokertegn.

svc.Files(foldername: str, filter: str = ''): str[0..*]

mappenavn: En streng som representerer en mappe. Mappen må eksistere. Dette argumentet må ikke angi en fil.

filter: En streng som inneholder jokertegn ("?" og "*") som vil bli brukt på den resulterende listen over filer (standard = "").

      Dim filesList As Variant, file As String
      FSO.FileNaming = "SYS"
      filesList = FSO.Files("/home/user/", "*.txt")
      For Each file In filesList
          ' ...
      Next file
    

      fso.FileNaming = "SYS"
      filesList = fso.Files("/home/user/", "*.txt")
      for file in fileList:
          # ...
    

FolderExists

Returnerer True hvis det spesifiserte FolderName er gyldig og eksisterer, ellers returnerer metoden Usann.

Hvis parameteren mappenavn faktisk er et eksisterende filnavn, returnerer metoden Usann.

svc.FolderExists(foldername: str): bool

mappenavn: En streng som representerer mappen som skal testes.

      FSO.FileNaming = "SYS"
      If FSO.FolderExists("C:\Documents\Thesis") Then
          '...
      End If
    

      fso.FileNaming = "SYS"
      if fso.FolderExists(r"C:\Documents\Thesis")
          # ...
    

GetBaseName

Returnerer BaseName (lik den siste komponenten) til en mappe eller filnavn, uten filtypen.

Metoden sjekker ikke om den angitte filen eller mappen eksisterer.

svc.GetBaseName(filename: str): str

filnavn: En streng som representerer filnavnet og dens bane.

I eksemplene nedenfor tilsvarer det første GetBaseName metodekallet en mappe, så funksjonen returnerer den siste komponenten i stien. Den andre samtalen mottar et filnavn som input, så navnet på filen returneres uten filtypen.

      MsgBox FSO.GetBaseName("/home/user/Documents") ' "Documents"
      MsgBox FSO.GetBaseName("/home/user/Documents/my_file.ods") ' "my_file"
    

      bas = CreateScriptService("Basic")
      bas.MsgBox(fso.GetBaseName("/home/user/Documents")) # "Documents"
      bas.MsgBox(fso.GetBaseName("/home/user/Documents/my_file.ods")) # "my_file"
    

GetExtension

Returnerer utvidelsesdelen av et fil- eller mappenavn uten prikken "." tegn.

Metoden sjekker ikke eksistensen av den angitte filen eller mappen.

Hvis denne metoden brukes på et mappenavn eller på en fil uten utvidelse, returneres en tom streng.

svc.GetExtension(filename: str): str

filnavn: En streng som representerer filnavnet og dens sti.

      ' Basic
      ext = FSO.GetExtension("C:\Windows\Notepad.exe")  ' "exe"
    

      # Python
      ext = fso.GetExtension(r"C:\Windows\Notepad.exe")  # "exe"
    

GetFileLen

Den innebygde FileLen Basic-funksjonen returnerer antall byte i en fil som en Long-verdi, dvs. opptil 2 GB.

Metoden GetFileLen kan håndtere filer med mye større størrelser ved å returnere en Valuta-verdi.

svc.GetFileLen(filename: str): num

filnavn: En streng som representerer en eksisterende fil.

      Dim fLen As Currency
      FSO.FileNaming = "SYS"
      fLen = FSO.GetFileLen("C:\pagefile.sys")
    

      fso.FileNaming = "SYS"
      fLen = fso.GetFileLen(r"C:\pagefile.sys")
    

GetFileModified

Returnerer den siste endrede datoen for en gitt fil.

svc.GetFileModified(filename: str): datetime

filnavn: En streng som representerer en eksisterende fil.

      Dim aDate As Date
      FSO.FileNaming = "SYS"
      aDate = FSO.GetFileModified("C:\Documents\my_file.odt")
    

      fso.FileNaming = "SYS"
      aDate = FSO.GetFileModified(r"C:\Documents\my_file.odt")
    

GetName

Returnerer den siste komponenten i et fil- eller mappenavn i opprinnelig operativsystemformat.

Metoden sjekker ikke om den angitte filen eller mappen eksisterer.

svc.GetName(filename: str): str

filnavn: En streng som representerer filnavnet og dens bane.

      ' Basic
      a = FSO.GetName("C:\Windows\Notepad.exe")  ' Notepad.exe
    

      # Python
      a = fso.GetName(r"C:\Windows\Notepad.exe")  # Notepad.exe
    

GetParentFolderName

Returnerer en streng som inneholder navnet på den overordnede mappen til et spesifisert fil- eller mappenavn.

Metoden sjekker ikke om den angitte filen eller mappen eksisterer.

svc.GetParentFolderName(filename: str): str

filnavn: En streng med fil- eller mappenavnet som skal analyseres.

      ' Basic
      a = FSO.GetParentFolderName("C:\Windows\Notepad.exe")  ' C:\Windows\
    

      # Python
      a = fso.GetParentFolderName(r"C:\Windows\Notepad.exe")  # C:\Windows\
    

GetTempName

Returnerer et tilfeldig generert midlertidig filnavn som er nyttig for å utføre operasjoner som krever en midlertidig fil.

Det returnerte filnavnet har ikke noe suffiks. Mappedelen av den returnerte strengen er systemets midlertidige mappe.

Metoden oppretter ikke den midlertidige filen.

svc.GetTempName(): str

      Dim fName As String
      FSO.FileNaming = "SYS"
      fName = FSO.GetTempName() & ".txt"
      ' "/tmp/SF_574068.txt"
    

      fso.FileNaming = "SYS"
      fName = FSO.GetTempName() + ".txt"
      # "/tmp/SF_574068.txt"
    

HashFile

Hash-funksjoner brukes av noen kryptografiske algoritmer, i digitale signaturer, meldingsautentiseringskoder, svindeldeteksjon, fingeravtrykk, sjekksummer (meldingsintegritetssjekk), hashtabeller, passordlagring og mye mer.

Metoden HashFile returnerer resultatet av en hash-funksjon, brukt på en gitt fil og ved hjelp av en spesifisert algoritme. Den returnerte verdien er en streng med små heksadesimale tall.

Hash-algoritmene som støttes er: MD5, SHA1, SHA224, SHA256, SHA384 og SHA512.

svc.HashFile(filename: str, algorithm: str): str

filnavn: En streng som representerer en eksisterende fil.

algoritme: En av de støttede algoritmene.

      ' Basic
      sHash = FSO.HashFile("C:\pagefile.sys", "MD5")
    

      # Python
      sHash = FSO.HashFile(r"C:\pagefile.sys", "MD5")
    

MoveFile

Flytter én eller flere filer fra ett sted til et annet. Returnerer Sann hvis minst én fil har blitt flyttet eller Usann hvis det oppstod en feil.

En feil vil også oppstå hvis parameteren kilde bruker jokertegn og ikke samsvarer med noen filer.

Metoden stopper umiddelbart etter at den støter på en feil. Metoden ruller ikke tilbake og angrer heller ikke endringer som ble gjort før feilen oppsto.

svc.MoveFile(source: str, destination: str): bool

kilde: Det kan være et Filnavn eller Navnemønster for å angi én eller flere filer som skal flyttes.

destinasjon: Hvis kilde er et Filnavn, indikerer denne parameteren den nye banen og filnavnet til den flyttede filen.

Hvis flyttingen involverer flere filer, må destinasjon være et mappenavn. Hvis det ikke finnes, er det opprettet.

Hvis kilde og destinasjon har samme overordnede mappe, vil metoden gi nytt navn til kilden.

Jokertegn er ikke tillatt i destinasjon.

I de følgende eksemplene flyttes bare filer, ikke undermapper.

      ' Basic
      FSO.MoveFile("C:\Temp1\*.*", "C:\Temp2")
    

      # Python
      fso.MoveFile(r"C:\Temp1\*.*", r"C:\Temp2")
    

MoveFolder

Flytter én eller flere mapper fra ett sted til et annet. Returnerer True hvis minst én mappe har blitt flyttet eller False hvis det oppstod en feil.

En feil vil også oppstå hvis parameteren kilde bruker jokertegn og ikke samsvarer med noen mapper.

Metoden stopper umiddelbart etter at den støter på en feil. Metoden ruller ikke tilbake og angrer heller ikke endringer som ble gjort før feilen oppsto.

svc.MoveFolder(source: str, destination: str): bool

kilde: Det kan være et FolderName eller NamePattern for å angi en eller flere mapper som skal flyttes.

destinasjon: Hvis flytteoperasjonen involverer en enkelt mappe, er destinasjon navnet og banen til den flyttede mappen, og den kan ikke eksistere.

Hvis flere mapper flyttes, angir destinasjon hvor mappene i kilde skal flyttes til. Hvis destinasjon ikke eksisterer, blir den opprettet.

Jokertegn er ikke tillatt i destinasjon.

      ' Basic
      FSO.MoveFolder("C:\Temp1\*", "C:\Temp2")
    

      # Python
      fso.MoveFolder(r"C:\Temp1\*", r"C:\Temp2")
    

OpenTextFile

Åpner en fil og returnerer et TextStream-objekt som kan brukes til å lese fra, skrive til eller legge til filen.

Merk at metoden ikke sjekker om den gitte filen virkelig er en tekstfil.

Metoden returnerer et Null-objekt (i Basic) eller Ingen (i Python) hvis det oppstod en feil.

svc.OpenTextFile(filename: str, iomode: int = 1, create: bool = False, encoding: str = 'UTF-8'): svc

filnavn: Identifiserer filen som skal åpnes.

iomode: Indikerer inn-/utgangsmodus. Det kan være en av tre konstanter: svc.ForReading (standard), svc.ForWriting eller svc.ForAppending.

opprett: Boolsk verdi som indikerer om en ny fil kan opprettes hvis det angitte filnavnet ikke eksisterer:

• Hvis Sann vil en ny fil og dens overordnede mapper bli opprettet hvis de ikke eksisterer;

• Hvis Usann opprettes ikke nye filer (standard).

koding: Tegnsettet som skal brukes. Standardkodingen er "UTF-8".

      Dim myFile As Object
      FSO.FileNaming = "SYS"
      Set myFile = FSO.OpenTextFile("C:\Temp\ThisFile.txt", FSO.ForReading)
      If Not IsNull(myFile) Then
          ' ...
      End If
    

      fso.FileNaming = "SYS"
      myFile = fso.OpenTextFile(r"C:\Temp\ThisFile.txt", fso.ForReading)
      if myFile is not None:
          # ...
    

PickFile

Åpner en dialogboks for å åpne eller lagre filer.

Hvis LAGRE-modusen er satt og den valgte filen eksisterer, vil en advarsel vises.

svc.PickFile(defaultfile: str ='', mode: str = 'OPEN', filter: str = ''): str

standardfil: Dette argumentet er en streng som består av en mappe og et filnavn:

• Mappedelen indikerer mappen som vil vises når dialogen åpnes (standard = den sist valgte mappen).

• Fildelen angir standardfilen som skal åpnes eller lagres.

modus: En strengverdi som kan være enten "OPEN" (for inndatafiler) eller "SAVE" (for utdatafiler). Standardverdien er "OPEN".

filter: Utvidelsen til filene som vises når dialogboksen åpnes (standard = ingen filter).

Eksemplene nedenfor åpner en filvelger med "txt"-filteret brukt.

      ' Basic
      aFile = FSO.PickFile("C:\Documents", "OPEN", "txt")
    

      # Python
      aFile = fso.PickFile(r"C:\Documents", "OPEN", "txt")
    

PickFolder

Åpner en dialogboks for å velge en mappe.

svc.PickFolder(defaultfolder: str = '', freetext: str = ''): str

standardmappe: En streng som inneholder mappenavnet som vil vises når dialogboksen åpnes (standard = den sist valgte mappen).

fritekst: Tekst som skal vises i dialogboksen (standard = "").

      ' Basic
      aFolder = FSO.PickFolder("C:\Documents", "Velg en mappe eller trykk på Avbryt")
    

      # Python
      aFolder = fso.PickFolder(r"C:\Documents", "Choose a folder or press Cancel")
    

SubFolders

Returnerer en null-basert matrise med strenger som tilsvarer mappene som er lagret i et gitt mappenavn.

Listen kan filtreres med jokertegn.

svc.SubFolders(foldername: str, filter: str = ''): str[0..*]

mappenavn: En streng som representerer en mappe. Mappen må eksistere. mappenavn må ikke angi en fil.

filter: En streng som inneholder jokertegn ("?" og "*") som vil bli brukt på den resulterende listen over mapper (standard = "").

      Dim folderList As Variant, folder As String
      FSO.FileNaming = "SYS"
      folderList = FSO.SubFolders("/home/user/")
      For Each folder In folderList
          ' ...
      Next folder
    

      fso.FileNaming = "SYS"
      folderList = fso.SubFolders("/home/user/")
      for folder in folderList:
          # ...
    

Alle ScriptForge Grunnleggende rutiner eller identifikatorer som er prefikset med et understrekingstegn "_" er reservert for intern bruk. De er ikke ment å brukes i grunnleggende makroer eller Python-skript.