Aztec® Programming Language
Version 1.1 Alpha 2

Copyright © 2010-2017, Aztec Development Group, All Rights Reserved

Download Aztec

Search        Contact Us

Confusion has its cost.

- Stephen Stills

 

aztec.file.FolderEntry

public class FolderEntry from<Base>

Base

FolderEntry

The FolderEntry class is an abstract class which provides a framework for objects which reside in an OS file system, including the 'File' and 'Folder' classes.

FolderEntry Methods

FolderEntry() Constructor for the FolderEntry class using a fully qualified name
Name() Method to return the name of the item (local name or full name)
Exists() Abstract method to determine existence of the folder entry object
Rename() Abstract method to rename the folder entry
Delete() Abstract method to delete the folder entry
Time() Method to return Time object representing last modification time
IsHidden() Method returns true if folder entry has Hidden attribute set
IsSystem() Method returns true if folder entry has System attribute set
IsArchive() Method returns true if folder entry has Archive attribute set
IsReadOnly() Method returns true if folder entry has ReadOnly attribute set

Derived Classes

See Also

 


FolderEntry()

public method FolderEntry(string Name)

Parameters

Name

Full name of the directory entry

Return Value

None

Description

Constructor for the abstract FolderEntry class. The full name of the entry is passed in (including drive and path). If a local/relative name is passed in, the default folder/directory will be prepended. The default folder is the folder where the Aztec program was loaded from, but can also be changed using the "Script.SetDefaultFolder()" method.

 

FolderEntry Class


Name()

public method<string> Name(bool FullName = false)

Parameters

FullName

Return full name if true

Return Value

Returns name of item

Description

This method returns the name of the folder entry. The "FullName" boolean flag determines whether the full path name is returned (true) or the local name is returned (false).

 

FolderEntry Class


Exists()

public abstract method<bool> Exists()

Parameters

None

Return Value

True if the item exists

Description

Abstract method to determine existence of the folder entry item. If the item exists, it returns true, and if the item does not exist, it returns false.

 

FolderEntry Class


Rename()

public abstract method<int> Rename(string NewName)

Parameters

NewName

New name for the item

Return Value

Returns 0 if successful

Description

This abstract method renames the folder entry. The new name can either be a local name or a full name (including path). If a local name is provided, the entry is renamed within the same folder/directory. If a full name is provided, the entry is renamed and possibly moved to another folder. If successful, the method returns a value of zero.

 

FolderEntry Class


Delete()

public abstract method<int> Delete()

Parameters

None

Return Value

Returns 0 if successful

Description

This abstract method deletes the folder entry item. If successful, the method returns a value of zero.

 

FolderEntry Class


Time()

public virtual method<Time> Time()

Parameters

None

Return Value

Returns Time object reference

Description

This virtual method returns a Time object reference representing the last modification time for the folder entry.

 

FolderEntry Class


IsHidden()

public virtual method<bool> IsHidden()

Parameters

None

Return Value

Returns true if entry is hidden

Description

This virtual method returns true if the folder entry has the "hidden" attribute set.

 

FolderEntry Class


IsSystem()

public virtual method<bool> IsSystem()

Parameters

None

Return Value

Returns true if entry is system

Description

This virtual method returns true if the folder entry has the "system" attribute set.

 

FolderEntry Class


IsArchive()

public virtual method<bool> IsArchive()

Parameters

None

Return Value

Returns true if entry is archive

Description

This virtual method returns true if the folder entry has the "archive" attribute set.

 

FolderEntry Class


IsReadOnly()

public virtual method<bool> IsReadOnly()

Parameters

None

Return Value

Returns true if entry is read-only

Description

This virtual method returns true if the folder entry has the "readonly" attribute set.

 

FolderEntry Class

 

Copyright © 2010-2017

Aztec Development Group

All Rights Reserved

Download Aztec