CMS_IsPackageScheduleEnabled

Description

Checks if a given package has an active schedule

Syntax

CMS_IsPackageScheduleEnabled(sPackage, sVersion) As Boolean

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

Properties

sPackage (String)

Name of the package

sVersion (String)

Version of the package

Return value

Boolean, TRUE if function completed successfully. The result will be stored in gbValue. If the package is not found function will return false

Boolean, $true if the package has a schedule and it is enabled. Otherwise $false

Example

VBScript

If bStatus Then xStatus = CMS_IsPackageScheduleEnabled("CapaInstaller", "v1.0")
If bStatus Then
  xStatus = Job_WriteLog("Custom","gbValue: " & gbValue, bStatus, True)
End If

PowerShell

if (CMS_IsPackageScheduleEnabled "CapaInstaller"  "v1.0") {
  $cs.Job_WriteLog("Enabled","Package (CapaInstaller) has an enabled schedule")
}

Scripting Guidelines