CA Client Automation - 14.0

PDF
English

CreateDetectedSoftwarePatch

The CreateDetectedSoftwarePatch function adds a record to the software detection output file when the script detects a patch of a particular release. Add this function for every patch that you have included in the Intellisig script.
cla140
The CreateDetectedSoftwarePatch function adds a record to the software detection output file when the script detects a patch of a particular release. Add this function for every patch that you have included in the Intellisig script.
Function format:
CreateDetectedSoftwarePatch (ProductName as String, ProductVersionLabel, as String, ReleaseName as String, ReleaseVersionLabel as String, PatchName as String, PatchVersionLabel as String, OptionalProperties as String) as an integer
Example:
 
CreateDetectedSoftwarePatch ("Microsoft Windows 7 Ultimate", "6.1", "Microsoft Windows 7 Ultimate x64 64 en-us", "6.1.7600", "KB971033 x64 64 en-us", "Language=en-us |Bitness=64 |Architecture=x64 |Manufacturer=Microsoft Corporation|Category=Operating Systems |Description=The Microsoft Windows 7 Activation Checker Update")
Invoked this function after calling the CreateDetectedSoftwareRelease function within each script.
Input Parameters
This function has the following input parameters:
  • ProductName
    This parameter specifies the name of the product that the patch belongs to. You must have invoked the CreateDetectedSoftwareProduct function for this product within the script.
  • ProductVersionLabel
    This parameter specifies the version label of the product.
    The version label is used to identify the product together with its name. An empty value is allowed and is treated as a product with an empty version.
  • ReleaseName
    This parameter specifies the name of the release that the patch belongs to. You must have invoked the CreateDetectedSoftwareRelease function for this release within the script.
  • ReleaseVersionLabel
    This parameter specifies the version label of the release.
    The version label is used to identify the release together with its name. An empty value is allowed and is treated as a release with an empty version.
  • PatchName
    This parameter specifies the name of the detected software patch.
    A patch cannot have the same name as the release or product to which it belongs. The patch name and version label must be unique within each Intellisig software definition chain. Two patches with the same name within an Intellisig are treated as the same patch only if they have the same parent definitions, regardless of optional parameters. If the same patch is detected using two different Intellisigs, two separate detected records are created, one for each Intellisig.
  • PatchVersionLabel
    This parameter specifies the version label of the patch.
    The version label is used to identify the patch together with its name. An empty value is allowed and is treated as a patch with an empty version.
  • OptionalProperties
    This parameter specifies the optional properties that are associated with the detected software patch. Following optional properties are available for patches:
    • VersionNumber
      This optional property specifies the version number of the patch.
    • Language
      This optional property specifies the language in which the patch is installed.
    • Bitness
      This optional property specifies whether the patch uses 32-bit or 64-bit architecture.
    • Architecture
      This optional property specifies the architecture name that the patch uses.
    • Manufacturer
      This optional property specifies the patch manufacturer name.
    • Category
      This optional property specifies the patch category.
    • ManufacturerUUID
      This optional property specifies the UUID of the patch manufacturer.
    • CategoryUUID
      This optional property specifies the UUID of the patch category.
    • Description
      This optional property specifies the description of the patch.
Return Values
  • CA_SWDETECT_OK
    This value indicates that the function completed the operation successfully.
  • CASWDETECT_BADARGS
    This value indicates that one or more mandatory parameters that are passed to the function are blank.
  • CASWDETECT_FILE_ERROR
    This value indicates that the function was unable to write to the file. See the log file for more information.