Data ultimo aggiornamento: 13/06/2012

Documentazione oggetto BS--IOST

In Visual Basic 6 sono presenti tutta una serie di metodi che consentono l'accesso all'IO (ossia l'accesso al file system). In VBScript invece non sono disponibili tali funzioni. Per far si che all'interno delle Procedura del modulo Import/export, che fa uso di script in sintassi VBScript, sia possibile agire sul file system, è stato creato questo oggetto ActiveX che può essere istanziato all'interno di un qualsiasi script con questa sintassi:

'Dichiarazione dell'oggetto objIO
Dim objIo

'Creazione dell'oggetto objIO
Set objIO = CreateObject("BS__IOST.CLS__IOST")

'Utilizzo dell'oggetto objIO
...

'Distruzione dell'oggetto objIO
Set objIO = Nothing

I metodi che questo oggetto espone hanno, nella maggior parte dei casi, lo stesso nome e gli stessi parametri dei metodi che espone VB6. Per una documentazione completa dei metodi fare riferimento alla documentazione VB6.

I metodi di accesso all'IO non restituiscono mai un errore di run-time, perrtanto per verificare se l'ultimo metodo lanciato ha prodotto errore si testano le proprietà LastError e ErrorDescr. Esempio di cancellazione del file C:\Pippo.txt:

Sub EliminaFile
  Dim objIO
  Set objIO = CreateObject("BS__IOST.CLS__IOST")
  objIO.Kill "C:\PIPPO.TXT"
  If objIO.LastError <> 0 Then
    MsgBox "Errore durante l'eliminazione del file C:\PIPPO.TXT: " & _
           "Errore " & objIO.LastError & ": " & objIO.ErrorDescr
    Set objIO = Nothing
    Exit Sub
  End If
  MsgBox "File C:\PIPPO.TXT cancellato correttamente."
  Set objIO = Nothing
End Sub 

Elenco metodi/proprietà disponibili

Procedura FileExists

Tipo: Subroutine
Scope: Public
Note:
Restituisce True se il nome del file (persorso/nome) passato nel parametro strPathNome esiste sul file sistem, False se non esiste. Funzione non esistente in VB6
Dichiarazione:
FileExists(ByVal strPathNome) As Integer
Parametri:

Procedura ChDir

Tipo: Subroutine
Scope: Public
Note:
Imposta una diversa directory o cartella predefinita.
Dichiarazione:
Public Sub ChDir(Path)
Parametri:

Procedura ChDrive

Tipo: Subroutine
Scope: Public
Note:
Passa a un'unità diversa dalla corrente. L'argomento obbligatorio Drive è un'espressione stringa che specifica un'unità esistente. Se viena specificata una stringa di lunghezza zero (""), l'unità corrente resterà invariata. Se l'argomento unità è costituito da una stringa di più caratteri, ChDrive utilizzerà solo la prima lettera.
Dichiarazione:
Public Sub ChDrive(Drive)
Parametri:

Procedura CurDir

Tipo: Function
Scope: Public
Note:
Restituisce un valore Variant (String) che rappresenta il percorso corrente dell'unità specificata. L'argomento facoltativo Drive è un'espressione stringa che specifica un'unità esistente. Se non è specificata alcuna unità o se l'argomento unità è una stringa di lunghezza zero (""), CurDir restituirà il percorso dell'unità corrente.
Dichiarazione:
Public Function CurDir(Optional Drive)
Parametri:

Procedura Dir

Tipo: Function
Scope: Public
Note:
Restituisce un valore String che rappresenta un nome di file, directory, o cartella che corrisponde a un attributo o tipo di file specificato o a un'etichetta di volume di un'unità.
Dichiarazione:
Public Function Dir(Optional PathNome, Optional Attributes) As String
Parametri:

Procedura EOF

Tipo: Function
Scope: Public
Note:
Restituisce un valore Integer che contiene il valore Boolean True se è stata raggiunta la fine di un file aperto in modalità Random o Input sequenziale. è consigliabile utilizzare la funzione EOF per evitare errori dovuti al tentativo di leggere altri dati dopo aver raggiunto la fine del file. La funzione EOF restituisce False fino a quando non viene raggiunta la fine del file. Quando la funzione viene utilizzata con file aperti in modalità Random o Binary, restituirà False se l'ultima istruzione FileGet eseguita non è stata in grado di leggere un intero record. Se si tenta di leggere i file aperti in modalità Binary utilizzando la funzione Input fino a quando EOF non restituisce True, verrà generato un errore. Utilizzare le funzioni LOF e Loc al posto di EOF se per la lettura di file binari viene utilizzata Input oppure utilizzare FileGet con la funzione EOF. Con i file aperti in modalità Output, EOF restituisce sempre True.
Dichiarazione:
Public Function EOF(FileNumber) As Boolean
Parametri:

Proprietà ErrorDescr

Tipo: Proprietà (sola lettura)
Scope: Public
Note:
Restituisce la stringa dell'ultimo errore rilevato da un metodo IO. Rappresenta il testo dell'errore relativo al numero d'error indicato nella properità LastError.
Dichiarazione:
Public Property Get ErrorDescr() As String
Parametri: Nessuno

Procedura FileAttr

Tipo: Function
Scope: Public
Note:
Restituisce un valore Long che rappresenta la modalità di accesso a un file aperto con l'istruzione FileOpen.
Dichiarazione:
Public Function FileAttr(FileNumber, Optional ReturnTipo As Integer = 1) As Long
Parametri:

Procedura FileClose

Tipo: Subroutine
Scope: Public
Note:
Termina le operazioni di input/output (I/O) su un file aperto con la funzione FileOpen. Se si omette FileNumber, vengono chiusi tutti i file aperti con l'istruzione FileOpen. Quando l'istruzione FileClose viene utilizzata per un file aperto in modalità Output o Append, essa trasferisce il buffer finale dell'output al buffer del sistema operativo relativo a tale file, lasciando libero tutto lo spazio del buffer associato al file chiuso. L'esecuzione dell'istruzione FilrClose interrompe la corrispondenza tra un file e il suo numero. Questa Procedura rimappa il metodo Close di VB6
Dichiarazione:
Public Sub FileClose(Optional FileNumber)
Parametri:

Procedura FileCopy

Tipo: Subroutine
Scope: Public
Note:
Copia un file. Se si cerca di utilizzare l'istruzione FileCopy per un file aperto o inaccessibile, verrà generato un errore.
Dichiarazione:
Public Sub FileCopy(Source, Destination)
Parametri:

Esempio:

Sub CopiaFile()
  Dim objIO
  Set objIO = CreateObject("BS__IOST.CLS__IOST")
  
  objIO.FileCopy "C:\PIPPO.TXT", "A:\"
  If objIO.LastError <> 0 Then
    MsgBox "Errore " & objIO.LastError  & " durante la copia del file: " & _
           objIO.ErrorDescr
    Set objIO = Nothing
    Exit Sub
  Else
    MsgBox "Copia del file avvenuta correttamente."
  End If
  Set objIO = Nothing
End Sub

Procedura FileDateTime

Tipo: Function
Scope: Public
Note:
Restituisce un valore Variant (Date) che indica la data e l'ora in cui un file è stato creato o modificato.
Dichiarazione:
Public Function FileDateTime(PathNome)
Parametri:

Procedura FileGet

Tipo: Subroutine
Scope: Public
Note:
Trasferisce i dati da un file aperto in una variabile. Rimappa la funzione Get di VB6. Vedere documentazione VB6 per maggiori informazioni sui parametri e sull'utilizzo.
Dichiarazione:
Public Sub FileGet(FileNumber, Optional RecNumber, Optional VarNome)
Parametri:

Procedura FileInput

Tipo: Subroutine
Scope: Public
Note:
Restituisce un valore String che contiene i caratteri letti da un file aperto in modalità Input o Binary . I dati letti tramite la funzione FileInput vengono in genere scritti su file con FilePrint o FilePut. Utilizzare questa funzione solo per i file aperti in modalità Input o Binary. Rimappa il metodo Input di VB6
Dichiarazione:
Public Sub FileInput(FileNumber, VarList)
Parametri:

Procedura FileLen

Tipo: Function
Scope: Public
Note:
Restituisce un valore Long che specifica la lunghezza di un file espressa in byte.
Dichiarazione:
Public Function FileLen(PathNome) As Long
Parametri:

Procedura FileLineInput

Tipo: Subroutine
Scope: Public
Note:
Legge una singola riga in un file aperto ad accesso sequenziale e la assegna a una variabile String. Rimappa le parole chiave "Line Input #" di VB6. I dati letti tramite FileLineInput vengono in genere scritti su file con FilePrint. L'istruzione FileLineInput consente di leggere tutti i caratteri in un file un carattere per volta, fino al ritorno a capo (Chr(13)) o alla sequenza ritorno a capo–avanzamento riga (Chr(13) + Chr(10)). Le sequenze ritorno a capo–avanzamento riga vengono ignorate e non aggiunte alla stringa di caratteri.
Dichiarazione:
Public Sub FileLineInput(FileNumber, VarNome)
Parametri:

Procedura FileOpen

Tipo: Subroutine
Scope: Public
Note:
Consente di eseguire operazioni di input/output (I/O) su un file. Rimappa le istruzioni "Open ... For" di VB6. Prima di eseguire su un file una qualsiasi operazione di I/O, è necessario aprirlo. L'istruzione FileOpen assegna un buffer per eseguire le operazioni di I/O sul file e stabilisce la modalità di accesso utilizzata con il buffer. Se il file specificato con nomepercorso non esiste, verrà creato all'apertura di un file in modalità Append, Binary, Output o Random. Se il file è già stato aperto con un altro processo e il tipo di accesso specificato non è consentito, l'istruzione FileOpen non verrà eseguita e verrà generato un errore.
Dichiarazione:
Public Sub FileOpen(PathNome, FileNumber, Optional RecLength, Optional Mode, Optional LockTipo)
Parametri:

Esempio:

Sub LeggiFile()
  Dim objIO
  Dim nFile
  Dim strLine
  Set objIO = CreateObject("BS__IOST.CLS__IOST")
  
  nFile = objIO.FreeFile
  objIO.FileOpen "C:\PIPPO.TXT", nFile, , "INPUT"
  If objIO.LastError <> 0 Then
    MsgBox "Errore " & objIO.LastError  & " durante la lettura del file: " & _
           objIO.ErrorDescr
    Set objIO = Nothing
    Exit Sub
  End If
  Do While Not objIO.EOF(nFile)
    objIO.FileLineInput nFile, strLine
    MsgBox "Linea letta dal file '" & strLine  & "'"
  Loop
  objIO.FileClose nFile

  Set objIO = Nothing
End Sub

Procedura FilePrint

Tipo: Subroutine
Scope: Public
Note:
Scrive dati formattati per la visualizzazione in un file ad accesso sequenziale. Rimappa l'istruzione Print # di VB6
Dichiarazione:
Public Sub FilePrint(FileNumber, Optional OutputList)
Parametri:

Procedura FilePut

Tipo: Subroutine
Scope: Public
Note:
Scrive i valori di una variabile in un file su disco. Rimappa l'istruzione Put # di VB6
Dichiarazione:
Public Sub FilePut(FileNumber, Optional RecNumber, Optional VarNome)
Parametri:

Procedura FileSeek

Tipo: Function
Scope: Public
Note:
Restituisce un valore Long che specifica la posizione di lettura/scrittura corrente in un file aperto con l'istruzione FileOpen.. Rimappa l'istruzione Seek di VB6. La funzione FileSeek restituisce un valore compreso tra 1 e 2.147.483.647 inclusi.
Dichiarazione:
Public Function FileSeek(FileNumber) As Long
Parametri:

Procedura FreeFile

Tipo: Function
Scope: Public
Note:
Restituisce un valore Integer che rappresenta il successivo numero di file disponibile da utilizzare con l'istruzione FileOpen.
Dichiarazione:
Public Function FreeFile(Optional RangeNumber) As Integer
Parametri:

Procedura GetAttr

Tipo: Function
Scope: Public
Note:
Restituisce un valore Integer che rappresenta l'attributo di un file, di una directory o di una cartella. L'argomento obbligatorio PathNome è un'espressione stringa che specifica il nome del file. Può includere la directory o cartella e l'unità. Il valore restituito da GetAttr è la somma dei seguenti valori di attributo: 0=Normale, 1=Sola lettura, 2=Nascosto, 4=File di sistema, 16=Directory o cartella, 32=Il file è stato modificato dall'ultimo backup
Dichiarazione:
Public Function GetAttr(PathNome) As Integer
Parametri:

Procedura Kill

Tipo: Subroutine
Scope: Public
Note:
Elimina i file specificati da un disco. Con la funzione Kill è possibile utilizzare i caratteri jolly '*' (più caratteri) e '?' (carattere singolo) per indicare più file. L'utilizzo di Kill per eliminare un file aperto, genererà un errore. Per eliminare le directory utilizzare l'istruzione RmDir.
Dichiarazione:
Public Sub Kill(PathNome)
Parametri:

Proprietà LastError

Tipo: Proprietà (sola lettura)
Scope: Public
Note:
Contiene l'errore VB rilevato nell'ultimo operazione di IO. Nella proprietà ErrorDescr è contenuto il testo dell'errore.
Dichiarazione:
Public Property Get LastError() As Long
Parametri: Nessuno

Procedura Loc

Tipo: Function
Scope: Public
Note:
Restituisce un valore Long che specifica la posizione corrente di lettura/scrittura all'interno di un file aperto. Vedi documentazione VB6 per ulteriori informazioni.
Dichiarazione:
Public Function Loc(FileNumber) As Long
Parametri:

Procedura LOF

Tipo: Function
Scope: Public
Note:
Restituisce un valore Long che rappresenta le dimensioni in byte di un file aperto con l'istruzione FileOpen. Per ottenere la lunghezza di un file non aperto, utilizzare la funzione FileLen.
Dichiarazione:
Public Function LOF(FileNumber) As Long
Parametri:

Procedura MkDir

Tipo: Subroutine
Scope: Public
Note:
Crea una nuova directory o cartella. L'argomento obbligatorio Path è un'espressione stringa che identifica la directory o la cartella da creare. Può includere l'unità. Se l'unità non viene specificata, MkDir crea una nuova directory o cartella nell'unità corrente.
Dichiarazione:
Public Sub MkDir(Path)
Parametri:

Procedura Reset

Tipo: Subroutine
Scope: Public
Note:
Chiude tutti i file su disco aperti con la funzione FileOpen. L'istruzione Reset consente di chiudere tutti i file attivi aperti con l'istruzione Open e di scrivere il contenuto di tutti i buffer su disco.
Dichiarazione:
Public Sub Reset()
Parametri: Nessuno

Procedura RmDir

Tipo: Subroutine
Scope: Public
Note:
Rimuove una directory o cartella esistente. Se si tenta di utilizzare RmDir per rimuovere una directory o una cartella contenente dei file, verrà generato un errore. Prima di rimuovere la directory o la cartella, è necessario eliminare tutti i file con l'istruzione Kill.
Dichiarazione:
Public Sub RmDir(Path)
Parametri:

Procedura SetAttr

Tipo: Subroutine
Scope: Public
Note:
Imposta gli attributi di un file. Se si cerca di impostare attributi per un file aperto, verrà generato un errore.
Dichiarazione:
Public Sub SetAttr(PathNome, Attributes)
Parametri:

Procedura Shell

Tipo: Function
Scope: Public
Note:
Avvia un programma eseguibile e restituisce un valore Variant (Double) che indica l'ID del task del programma in caso di esito positivo oppure zero in caso di esito negativo. Se la funzione Shell esegue in modo corretto il file indicato, restituirà l'ID del task del programma avviato. L'ID del task è un numero univoco, che identifica il programma in esecuzione. Se la funzione Shell non riesce ad avviare il programma specificato, verrà generato un errore. La funzione Shell consente di eseguire altri programmi in modo asincrono. Ciò significa che non è necessario attendere la fine dell'esecuzione di un programma avviato con Shell prima che possano essere eseguite le istruzioni che seguono la funzione Shell nello script.
Dichiarazione:
Public Function Shell(PathNome, Optional WindowStyle) As Double
Parametri:

Procedura ShellSync

Tipo: Function
Scope: Public
Note:
Avvia un programma eseguibile. La funzione ShellSync consente di eseguire un programma in modo sincrono (modalità di attesa processo: WaitForSingleObject). Ciò significa che si attende la fine dell'esecuzione di un programma avviato con ShellSync prima che possano essere eseguite le istruzioni che seguono la funzione ShellSync nello script. Tale funzione restituisce -1 qualora il processo non sia stato eseguito (ad esempio errato il nome del comando lanciato/eseguibile). Se il programma viene eseguito la funzione restituisce il codice di uscita (ExitCode) del processo lanciato, valore che dipende dal programma lanciato. Solitamente se il valore di ritorno è zero il programma è uscito positivamente; un valore diverso da zero segnala una uscita anomala.
Dichiarazione:
Public Function ShellSync(ByVal strCmdLine As String, ByVal lCmdShow As Long) As Long
Parametri:

Procedura SendEmail

Tipo: Subroutine
Scope: Public
Note:
SendEmail è un metodo pubblico che consente di inviare una mail utilizzando i servizi di posta (Outlook) locali sulla macchina. Utilizza i controlli MAPISession e MAPIMessage. Questo metodo serve ad esempio per consentire all'interno di un profilo import export di inviare una mail. Questo metodo richiede che all'oggetto BS--IOST venga impostata la proprietà Std (vedi esempio sotto). Questo metodo è disponibile a partire dalla 11.0sr3
Dichiarazione:
Public Sub SendEMail(ByVal strTo As String, ByVal strCC As String, ByVal strCCN As String, ByVal strSubject As String, ByVal strText As String, ByVal strAttach As String, ByVal bSilent As Boolean)
Parametri:

Esempio:

Sub InviaEMail()
  Dim objIO
  Dim strTo, strCC, strCCN, strSubject, strText, strAttach
  Dim bSilent
  
  Set objIO = CreateObject("BS__IOST.CLS__IOST")
  Set objIo.Std = objstd
  
  strTo = "mpiomboni@ntsinformatica.it|marco.stefy@tin.it"
  strCC = "fsepe@ntsinformatica.it|fvalentini@ntsinformatica.it"
  strCCN = "dprocucci@ntsinformatica.it"
  strSubject = "prova di invio e-mail da profilo I.E."
  strText = "testo di prova......"  
  strAttach = "c:\bus\access\errorlog.txt|c:\marco piomboni\lorenzo.bmp"
  bSilent = False
  
  objIO.SendEMail strTo, strCC, strCCN, strSubject, strText, strAttach, bSilent
  Set objIO = Nothing
End Sub

Proprietà Std

Tipo: Proprietà (sola scrittura)
Scope: Public
Note:
Va referenziata con l'oggetto BS__STD correntemente aperto nel framework di Business. E' obbligatorio impostarla se si fa uso del metodo SendEmail.
Dichiarazione:
Public Property Set Std() As Object
Parametri: Nessuno