Class FileEntity

Class FileEntity describes file entity

Object fields

FileEntity.eid Entity ID
FileEntity.path path components for the file
FileEntity.size file size
FileEntity.attributes file attributes
FileEntity.times file time values
FileEntity.certificate file certificate information
FileEntity.resources file resources

Object methods

FileEntity:calcHashes (algorithms) Calculate md5, sha1 and sha256 hashes of the file and add field hashes to FileEntity

Constructors

FileEntity.fromHandle (handle) Create FileEntity from file handle
FileEntity.fromFullPath (fullPath) Create FileEntity from its full path
FileEntity.fromPath (path) Create FileEntity from its path Its strongly recommended to create FileEntity from full path with ${FileEntity.fromFullPath} if caller knows it


Object fields

FileEntity.eid
Entity ID
FileEntity.path
path components for the file
FileEntity.size
file size
FileEntity.attributes
file attributes
FileEntity.times
file time values

Fields:

  • change file last change time
  • write file last write time
  • read file last access time
  • create file create time
FileEntity.certificate
file certificate information

Fields:

  • status file sign status
  • signers list of signers
FileEntity.resources
file resources

Fields:

  • version
  • description
  • company
  • originalFileName

Object methods

FileEntity:calcHashes (algorithms)
Calculate md5, sha1 and sha256 hashes of the file and add field hashes to FileEntity

Parameters:

  • algorithms optional list of algorithms. md5, sha1 and sha256 are supported. If the list isn't defined all of them will be calculated

Constructors

FileEntity.fromHandle (handle)
Create FileEntity from file handle

Parameters:

  • handle opened handle to the file

Returns:

    FileEntity object
FileEntity.fromFullPath (fullPath)
Create FileEntity from its full path

Parameters:

  • fullPath absolute path to file

Returns:

    FileEntity object
FileEntity.fromPath (path)
Create FileEntity from its path Its strongly recommended to create FileEntity from full path with ${FileEntity.fromFullPath} if caller knows it

Parameters:

  • path relative or absolute path to file

Returns:

    FileEntity object
generated by LDoc 1.4.6 Last updated 2020-05-23 07:05:11