CMS_UninstallPackageFromUnitById
Description
Section titled “Description”Uninstalls package from unit. The status of the package for the unit is set to Uninstall in CapaInstaller, and the agent uninstalls the package.
The package must be linked to the unit. Otherwise, the function fails.
Syntax
Section titled “Syntax”CMS_UninstallPackageFromUnitById(sID) As Boolean[bool]CMS_UninstallPackageFromUnitById -packageid <string>Parameters
Section titled “Parameters”sID (String)
Section titled “sID (String)”ID of the package (JobId from the JOB table)
Return value
Section titled “Return value”Boolean, TRUE if function completed successfully.
Boolean, TRUE if function completed successfully.
Example
Section titled “Example”If bStatus Then bStatus = CMS_UninstallPackageFromUnitById("126")if (CMS_UninstallPackageFromUnitById '126') { $cs.Job_WriteLog("Uninstall", "Package (126) will be uninstalled")}Related functions
Section titled “Related functions”CMS_UninstallPackageFromUnit Constants Package Property Variables Business Unit support