Interface ZOSAPI::Tools::General::ICreateArchive

Definition:

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

Inherits from:

• ZOSAPI.Tools.ISystemTool

Members

• CanCancel
• Cancel
• Close
• ErrorMessage
• GetArchiveFileName
• IsAsynchronous
• IsFiniteDuration
• IsRunning
• IsValid
• Progress
• Run
• RunAndWaitForCompletion
• RunAndWaitWithTimeout
• SetArchiveFileName
• Status
• Succeeded
• UseDataCompression
• WaitForCompletion
• WaitWithTimeout

Properties

Property UseDataCompression

Definition:

bool ZOSAPI.Tools.General.ICreateArchive.UseDataCompression

Return type: bool

Public functions

Function GetArchiveFileName

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.

Returns:

The full path and name of the archive.

Return type: string

Function SetArchiveFileName

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.

Returns:

true if the specified name is valid; otherwise, false.

Parameters:

• string fullFileName

Return type: bool