The File Object Object - SyncScan Programming Interface

Document Path: Home Page / Console Programms / SyncScan / Interfaces / File Object Object  
Properties

AttributeAchive

Value BOOL
Access Read, Write
Notes FILE_ATTRIBUTE_ARCHIVE

AttributeDirectory

Value BOOL
Access Read
Notes FILE_ATTRIBUTE_ARCHIVE.

AttributeHidden

Value BOOL
Access Read, Write
Notes FILE_ATTRIBUTE_HIDDEN

AttributeReadonly

Value BOOL
Access Read, Write
Notes FILE_ATTRIBUTE_READONLY

Attributes

Value ULONG
Access Read, Write

AttribyteSystem

Value BOOL
Access Read, Write

CreationTime

Value File Time Object
Access Read, Write

ExtensionName

Value BSTR
Access Read

FileName

Value BSTR
Access Read, Write

FileSize

Value ULONG
Access Read
Notes Low part of the 64-bit file size

FileSizeHigh

Value ULONG
Access Read
Notes High part of the 64-bit file size

FullPath

Value BSTR
Access Read, Write

LastAccessTime

Value File Time Object
Access Read, Write

LastWriteTime

Value File Time Object
Access Read, Write

Parent

Value File Object
Access Read

Property

Value VARIANT
Arguments:
  • BSTR name
Access Read, Write
Notes For storing run-time values

Valid

Value BOOL
Access Read
Methods

Delete

Return Value
Notes Delete the file or directory

CompareFileSize

Return Value long (1=this file is larger; 0=both files are of the same size; -1=this file is smaller)
Arguments:
  • Object fileInfo2

HasChildren

Return Value BOOL
Notes Returns true if the object is a directory and has files or sub-directories in it.

CopyFile

Return Value
Arguments:
  • BSTR destFilePath
Notes Copy the file to a 'destFilePath'

CreateDirectory

Return Value

CompareFile

Return Value ULONG
Arguments:
  • BSTR file2Path
  • BOOL compareContents (Optional, default(0))
Notes
  • The current object must be a file.
  • The return value can be one or more of the following values:
    • 1: Not the same type - one object is a directory, and the other is a file
    • 2: Object 1 does not exist.
    • 4: Object 2 does not exist.
    • 8: Different size
    • 16: Different last-write time
    • 32: Object 1 is more recent
    • 64: Could not open object 1 for reading
    • 128: Could not open object 2 for reading
    • 256: Contents are different

MD5OfFile

Return Value BSTR