Interfaces and methods for creating a ZAR file. This interface can be accessed via the IOpticalSystemTools interface. More...

Inheritance diagram for ZOSAPI.Tools.General.ICreateArchive:

Public Member Functions
string	GetArchiveFileName ()
	Get the file name of the output archive. This will have a default value only if the default file did not already exist.

bool	SetArchiveFileName (string fullFileName)
	Set the file name of the output archive, including extension. Note that the output directory must exist prior to this call.

Public Member Functions inherited from ZOSAPI.Tools.ISystemTool
bool	Run ()
	Start the tool. Note that for synchronous tools (see IsAsynchronous), this call will block until completion. If it is asynchronous it will start running but return immediately.

bool	RunAndWaitForCompletion ()
	Sames as calling Run followed by WaitForCompletion.

bool	WaitForCompletion ()
	Waits for the asynchronous tool to complete.

bool	Cancel ()
	Cancels the currently running asynchronous tool.

bool	Close ()
	Closes this tool and frees up and associated resources.

RunStatus	WaitWithTimeout (double timeOutSeconds)
	Waits for the currently running tool to complete, with a specified time out value. Note that if the timeout is exceeded this method will return, however the tool will continue to run. Also note that this method will not start the tool running if it is not already.

RunStatus	RunAndWaitWithTimeout (double timeOutSeconds)
	Starts the tool running, and waits for it to complete with the specified timeout value. Note that if the timeout is exceeded this method will return, however the tool will continue to run.

Properties
bool	UseDataCompression `[get, set]`

Properties inherited from ZOSAPI.Tools.ISystemTool
int	Progress `[get]`
	Gets the progress of the current tool, if supported.

string	Status `[get]`
	Gets the status of the current tool, if supporoted.

bool	IsRunning `[get]`
	Gets a value indicating whether the tool is currently running asynchronously.

bool	CanCancel `[get]`
	Gets a value indicating whether the tool can be cancelled.

bool	IsAsynchronous `[get]`
	Gets a value indicating whether the tool runs asynchronously (i.e. on a thread).

bool	IsFiniteDuration `[get]`
	Gets a value indicating whether this tool will complete on its own.

bool	IsValid `[get]`
	Gets a value indicating whether the input settings are valid.

bool	Succeeded `[get]`
	Gets a value indicating whether the tool execution succeeded.

string	ErrorMessage `[get]`
	If Succeeded is `false`, get the error messages; otherwise, `null`.

Detailed Description

Interfaces and methods for creating a ZAR file. This interface can be accessed via the IOpticalSystemTools interface.

Member Function Documentation

string ZOSAPI.Tools.General.ICreateArchive.GetArchiveFileName ( )

Get the file name of the output archive. This will have a default value only if the default file did not already exist.

bool ZOSAPI.Tools.General.ICreateArchive.SetArchiveFileName ( string fullFileName )

Set the file name of the output archive, including extension. Note that the output directory must exist prior to this call.

Parameters

fullFileName Full path and name of the file.

bool ZOSAPI.Tools.General.ICreateArchive.UseDataCompression

getset