ARGetListLicense

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves a list of entries from the AR System License form for the specified server. The list can contain information for all types of licenses, including DSO, Flashboards, SMU applications, and servers.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARGetListLicense(
  ARControlStruct *control,
  ARLicenseNameType licenseType,
  ARLicenseInfoList *licenseInfoList,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

licenseType

The type of license to be retrieved. If the value of this argument is NULL, the function retrieves all the license types that are available.

Return values

licenseInfoList

A list of licenses that fit the specified criteria. For each license, information such as license key, license type, expiration date, number of licenses, and qualifier is included. If the Add or Remove Licenses form contains information not used by AR System, blank fields are returned in place of the unused information.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.