ARImportLicense

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

Imports the contents of a license file (arsystem.lic or a similarly formatted file) from a buffer into the Add or Remove Licenses form. Based on the value of the importOption argument, performs the import in one of the following ways:

Clears the contents of the form and replaces it with the contents of the file. Multiple entries in the file for the same license type are merged into one entry in the form.
Merges the contents of the file with the contents of the form as follows:
- When the form and the file contain a matching license type, the entries for that type are not imported from the file.
  For example: If the form has an entry for five AR User Fixed licenses and the file has an entry for three AR User Fixed licenses and another entry for four AR User Fixed licenses, the form retains its entry, and neither entry is imported from the file.
- When the file contains multiple entries for a particular license type and the form contains no matching entry, all entries in the file are imported into the form and merged into one entry.
  For example: If the form has no entries for AR User Fixed licenses and the file has an entry for three AR User Fixed licenses plus another entry for four AR User Fixed licenses, the two entries in the file are merged into one entry in the form. The new entry in the form is for seven AR User Fixed licenses.
  
  When called, the server validates that the buffer contains the text from a validly formatted license file, but it does not validate checksums or encryption.

Synopsis

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

int ARImportLicense(
  ARControlStruct *control,
  char *importBuf,
  unsigned int importOption,
  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.

importBuf

The text from a license file.

importOption

Indicates whether the license data is to be merged or overwritten.

Return values

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.