- Jimmy Page and Robert Plant
Folder
Folder Methods
| Folder() | Constructor for the Folder class |
| Exists() | Method to determine existence of the folder/directory |
| Rename() | Method to rename the folder |
| Delete() | Method to delete the folder |
| GetEntries() | Method to return an array of folder entries matching the specified mask and type mask. |
| CreateFolder() | Method to create a folder inside/underneath the folder associated with this object |
Folder Constants
| Constant Data Item | Data Type | Value |
| Folder.ShowAll | int | 1 |
| Folder.ShowFilesOnly | int | 2 |
| Folder.ShowFoldersOnly | int | 3 |
Derived Classes
None
See Also
public method Folder(string Name)
Parameters
Name
Full name of the directory
Return Value
None
Description
Constructor for the Folder class. The full name of the folder/directory 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.
Folder Class
public virtual method<bool> Exists()
Parameters
None
Return Value
True if the item exists
Description
Virtual method to determine existence of the folder/subdirectory. If the directory exists, it returns true, and if the folder does not exist, it returns false.
Folder Class
public virtual method<int> Rename(string NewName)
Parameters
NewName
New name for the directory
Return Value
Returns 0 if successful
Description
This virtual method renames the folder/directory. 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 parent folder. If a full name is provided, the folder is renamed and possibly moved to another folder. If successful, the method returns a value of zero.
Folder Class
public virtual method<int> Delete()
Parameters
None
Return Value
Returns 0 if successful
Description
This virtual method deletes the actual folder/directory referenced by this Folder object. The folder needs to be empty in order to delete it. If successful, the method returns a value of zero.
Folder Class
public method<FolderEntry[]> GetEntries(string FileMask = "*.*", int TypeMask = Folder.ShowAll)
Parameters
FileMask
File mask to filter names from the folder
TypeMask
Type mask to filter entry types from the folder
Return Value
Returns an array containing the Folder and/or File items matching the request
Description
This method returns an array of FolderEntry objects which match the specified request for this folder/directory. Each item in the list can either be a File object reference or a Folder object reference. The file mask is specified in the argument list ("*.*" is the default), and the Type Mask is also specified in the argument list (Folder.ShowAll is the default). Other valid values for the TypeMask are Folder.ShowFilesOnly and Folder.ShowFoldersOnly. If there are no matching entries, the return array will be null.
Folder Class
public method<Folder> CreateFolder(string FolderName)
Parameters
FolderName
Folder name to be created inside this object's folder
Return Value
Returns Folder object if successful, null if not
Description
This method attempts to create a new OS folder underneath the folder contained in this object. If successful, this method will return a Folder object associated with the new OS folder, and it will return null if not successful.
Folder Class