Questa funzione esegue il cambiamento del nome di un file. In OldName occorre definire il nome del file da rinominare specificando l'intero percorso (Esempio C:\Directory\OldFile.txt), in NewName occorre definire il nuovo nome del file specificando l'intero percorso (Esempio C:\Directory\NewFile.txt).
Se l'operazione di rinomina va a buon fine la funzione ritorna TRUE, in caso di errore viene ritornato FALSE.
Function
CODESYS: Non disponibile
LogicLab: eLLabXUnified12Lib
OldName (@STRING) Nome del file da rinominare compreso di percorso.
NewName (@STRING) Nuovo nome da dare al file compreso di percorso.
La funzione ritorna un (BOOL), FALSE se errore esecuzione, TRUE se esecuzione Ok.
Errori
In caso di errore la funzione ritorna FALSE, eseguendo immediatamente dopo la funzione SysGetLastError è possibile rilevare il codice di errore. Fare riferimento alla tabella seguente per la descrizione.
Esempi
Come utilizzare gli esempi.
Nell'esempio attivando da debug la variabile Rename, il file C:\Directory\OldFile.txt se presente viene rinominato C:\Directory\NewFile.txt e la variabile viene resettata. In caso di errore di esecuzione il codice di errore è memorizzato nella variabile ECode.
PROGRAM ST_SysFileRename
VAR
Rename : BOOL; (* Rename command *)
ECode : UDINT; (* Error code *)
END_VAR
// *****************************************************************************
// PROGRAM "ST_SysFileRename"
// *****************************************************************************
// By setting the Rename command a file is renamed.
// -----------------------------------------------------------------------------
IF (Rename) THEN
Rename:=FALSE; //Rename command
IF NOT(SysFileRename(ADR('C:\Directory\OldFile.txt'), ADR('C:\Directory\NewFile.txt'))) THEN
ECode:=SysGetLastError(TRUE); //Error code
END_IF;
END_IF;
// [End of file]