CMS_SetPackageStatusToNotCompliant

Description

Implemented in CapaInstaller 5.0 Build 103

Will set the status of the running package to 'Not Compliant'.
This function is intended to be used before the package has been downloaded and/or before the user has been prompted to allow installation of the package.

Syntax

CMS_SetPackageStatusToNotCompliant(sPackage, sVersion) As Boolean

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

Parameters

sPackage (String)

Package name

sVersion (String)

Package version

Return value

Boolean, TRUE if function completed successfully.

Example

The example below shows how this function could be used in a real world situation. The CompliancyCheck function could be included in the package itself or provided via CustomLib.cis and will prevent a package from running on 64 bit OS in this case.

VBScript

' this function will set bStatus to FALSE in order to skip the Job execution.'
Function CompliancyCheck()
  Dim bStatus : bStatus = True
  If gbx64 Then
    If bStatus Then bStatus = Job_WriteLog("CompliancyCheck", "Package is not allowed to run on 64 bit OS", bStatus, True)
    If bStatus Then bStatus = CMS_SetPackageStatusToNotCompliant("CapaInstaller", "v1.0")
  End If
  CompliancyCheck = bStatus
End Function

PowerShell

# this function will set the package status to NotCompliant
function CompliancyCheck() {
  $result = true
  if ($env:PROCESSOR_ARCHITECTURE -eq "AMD64") {
    $cs.Job_WriteLog("CompliancyCheck", "Package is not allowed to run on 64 bit OS")    
    $result = CMS_SetPackageStatusToNotCompliant -package 'AutoCad 11' -version 'v1.0'
  }
  return $result
}

Scripting Guidelines

Related functions

CMS_SetPackageStatusToInstalled