ArchiveManager Class Reference

Managing Archive. More...

Inheritance diagram for ArchiveManager:

Collaboration diagram for ArchiveManager:

Static Public Member Functions
_.Library.Status	DeleteFile (_.Library.SysPath FileName, _.Library.String ArchiveSpec, _.Library.Boolean Verbose)
	Managing Archive. More...
_.Library.Status	GetFile (_.Library.SysPath FilePath, _.Library.String ArchiveSpec, _.Library.Boolean Move, _.Library.Boolean Verbose)
	Copy a file to 'FilePath' from a given archive source. More...
_.Library.Status	PutFile (_.Library.SysPath FilePath, _.Library.String ArchiveName, _.Library.String ArchiveSpec, _.Library.Boolean Move, _.Library.Boolean Verbose)
	Put a file given by 'FilePath' on a given archive destination. More...

Detailed Description

Managing Archive.

Member Function Documentation

DeleteFile()

_.Library.Status DeleteFile ( _.Library.SysPath  FileName, _.Library.String  ArchiveSpec, _.Library.Boolean  Verbose  )

static

Managing Archive.

Delete a file from a given archive target.

Parameters:
FileName: the name of the file to delete (case sensitive)
ArchiveSpec: the specification of the archive target where the file is located, i.e., a comma-delimited string of the type and the location of the archive target.
Verbose: whether to display output messages from the command. Default is No.

GetFile()

_.Library.Status GetFile ( _.Library.SysPath  FilePath, _.Library.String  ArchiveSpec, _.Library.Boolean  Move, _.Library.Boolean  Verbose  )

static

Copy a file to 'FilePath' from a given archive source.

Parameters:
FilePath: the path of the destination file
ArchiveSpec: the specification of the archive source, i.e., a comma-delimited string of the type and the location of the archive source.
Move: whether to remove the file from the archive source. Default is No.
Verbose: whether to display output messages from the command. Default is No.

PutFile()

_.Library.Status PutFile ( _.Library.SysPath  FilePath, _.Library.String  ArchiveName, _.Library.String  ArchiveSpec, _.Library.Boolean  Move, _.Library.Boolean  Verbose  )

static

Put a file given by 'FilePath' on a given archive destination.

Parameters:
FilePath: the path of the source file
ArchiveName: the name of the archive destination defined in CPF file
ArchiveSpec (input/output): the specification of the archive destination, i.e., a comma-delimited string of the type and the location of the archive destination.
Move: whether to remove the source file. Default is No.
Verbose: whether to display output messages from the command. Default is No.