70. FileUtils

Module for getting information about files and directories. Their types and sizes and functions for checking, creating and removing them. Flags: Stable

70.1. Summary of Module Globals

List of Global Functions

  • CheckAndCreatePath - Checks whether the path (directory) exists and return a boolean value whether everything is OK or user accepted the behavior as despite some errors. If the directory doesn't exist, it offers to create it (and eventually creates it).

  • Exists - Function which determines if the requested file/directory exists.

  • GetFileRealType - Function returns the real type of requested file/directory. If the file is a link to any object, "link" is returned.

  • GetFileType - Function returns the type of requested file/directory. If the file is a link to any object, the object's type is returned.

  • GetOwnerGroupID - Function which determines the owner's group ID of requested file/directory.

  • GetOwnerUserID - Function which determines the owner's user ID of requested file/directory.

  • GetSize - Function which returns the size of requested file/directory.

  • IsBlock - Function which determines if the requested file/directory is a block file (device) or link to a block device.

  • IsCharacterDevice - Function which determines if the requested file/directory is a character device or link to a character device.

  • IsDirectory - Function which determines if the requested file/directory is a directory or it is a link to a directory.

  • IsFifo - Function which determines if the requested file/directory is a fifo or link to a fifo.

  • IsFile - Function which determines if the requested file/directory is a regular file or it is a link to a regular file.

  • IsLink - Function which determines if the requested file/directory is a link.

  • IsSocket - Function which determines if the requested file/directory is a socket or link to a socket.

List of Global Variables

    70.2. Global Functions

    70.2.1. CheckAndCreatePath

    Checks whether the path (directory) exists and return a boolean value whether everything is OK or user accepted the behavior as despite some errors. If the directory doesn't exist, it offers to create it (and eventually creates it).

    Function parameters

    • string pathvalue

    Return value

    • boolean - whether everything was OK or whether user decided to ignore eventual errors

    70.2.2. Exists

    Function which determines if the requested file/directory exists.

    Function parameters

    • string target

    Return value

    • boolean - true if exists

    70.2.3. GetFileRealType

    Function returns the real type of requested file/directory. If the file is a link to any object, "link" is returned.

    Function parameters

    • string target

    Return value

    • string - fle type (directory|regular|block|fifo|link|socket|chr_device), nil if doesn't exist

    70.2.4. GetFileType

    Function returns the type of requested file/directory. If the file is a link to any object, the object's type is returned.

    Function parameters

    • string target

    Return value

    • string - fle type (directory|regular|block|fifo|link|socket|chr_device), nil if doesn't exist

    70.2.5. GetOwnerGroupID

    Function which determines the owner's group ID of requested file/directory.

    Function parameters

    • string target

    Return value

    • integer - GID, nil if doesn't exist

    70.2.6. GetOwnerUserID

    Function which determines the owner's user ID of requested file/directory.

    Function parameters

    • string target

    Return value

    • integer - UID, nil if doesn't exist

    70.2.7. GetSize

    Function which returns the size of requested file/directory.

    Function parameters

    • string target

    Return value

    • integer - file size, -1 if doesn't exist

    70.2.8. IsBlock

    Function which determines if the requested file/directory is a block file (device) or link to a block device.

    Function parameters

    • string target

    Return value

    • boolean - true if it is a block file, nil if doesn't exist

    70.2.9. IsCharacterDevice

    Function which determines if the requested file/directory is a character device or link to a character device.

    Function parameters

    • string target

    Return value

    • boolean - true if it is a charcater device, nil if doesn't exist

    70.2.10. IsDirectory

    Function which determines if the requested file/directory is a directory or it is a link to a directory.

    Function parameters

    • string target

    Return value

    • boolean - true if it is a directory, nil if doesn't exist

    70.2.11. IsFifo

    Function which determines if the requested file/directory is a fifo or link to a fifo.

    Function parameters

    • string target

    Return value

    • boolean - true if it is a fifo, nil if doesn't exist

    70.2.12. IsFile

    Function which determines if the requested file/directory is a regular file or it is a link to a regular file.

    Function parameters

    • string target

    Return value

    • boolean - true if it is a regular file, nil if doesn't exist

    70.2.13. IsLink

    Function which determines if the requested file/directory is a link.

    Function parameters

    • string target

    Return value

    • boolean - true if it is a link, nil if doesn't exist

    70.2.14. IsSocket

    Function which determines if the requested file/directory is a socket or link to a socket.

    Function parameters

    • string target

    Return value

    • boolean - true if it is a socket, nil if doesn't exist

    70.3. Global Variables

    70.4. Module Requirements

    70.4.1. Module Imports

    • Popup
    • SCR

    70.4.2. Module Includes