CMS_GetPackageStatus

Description

Returns the local status for the specified package. Values can be ‘Installed', 'Installing', 'Waiting', 'Failed', 'Not Scheduled' or 'Package not found’. 'Not scheduled' indicates that the package is not linked to the unit

Syntax

CMS_GetPackageStatus(sPackage, sVersion) As Boolean

[bool]CMS_GetPackageStatus -package <string> -version <string>

Parameters

sPackage (String)

Name of package

sVersion (String)

Version of package

Return value

Boolean, TRUE if function completed successfully. The result will be stored in gsValue

Result will be returned as the result of the function.

Example

VBScript

If bStatus Then bStatus = CMS_GetPackageStatus("CapaInstaller", "v1.0")
If bStatus Then bStatus = Job_WriteLog("Custom", "gsValue: " & gsValue, bStatus, True)

PowerShell

$status = CMS_GetPackageStatus 'AutoCad 11' 'v1.0'
$cs.Job_WriteLog("Status: " "The AutoCad 11 package status is $status")

#Expected output:
2023-11-19 23:13:04 - Status: The AutoCad 11 package status is Installed

Scripting Guidelines

CapaInstaller 6.6 Documentation Public