AIDA_boGetLicenseInfo

The AIDA_boGetLicenseInfo function returns either an overview/summary of the AIDA license data or some specific single license data, depending on the value of parameter enLicInfoType.
Precondition is that previously AIDA_boLoadLicenseFile() has been called without error code EOSAL_LICENSE_NOT_FOUND.

bool AIDA_boGetLicenseInfo(
  byte en8LicInfoType,
  char *xsLicInfo,
  dword dwLicInfoBufferSize
);

Parameters

enLicInfoType

The type/kind of the license information to retrieve.
The supported values are: AIDA_nen8LitLicenseSummary, AIDA_nen8LitLicenseFilename, AIDA_nen8LitLicenseID, AIDA_nen8LitLicenseExpirationDate, AIDA_nen8LitLicenseeName, AIDA_nen8LitLicenseeCompanyName, AIDA_nen8LitLicenseeAddress, AIDA_nen8LitLicensedApplications, AIDA_nen8LitLicensedPIModules, AIDA_nen8LitLicensedComponents, AIDA_nen8LitLicensedPlugins

xsLicInfo

The buffer for the license information. xsLicInfo will be terminated with a '\0' character in any case.

dwLicInfoBufferSize

The size of the buffer xsLicInfo. This must be at least AIDA_nLicenseInfoBufSizeMax (in bytes).

Return Values

AIDA_boGetLicenseInfo returns true only if the license information could be successfully retrieved. In this case xsLicInfo contains the license information text.

If the function fails, the returned value is false. The application can retrieve the error code using AIDA_iGetError(). Possible licensing-specific error codes set by this function are:
  EOSAL_LICENSE_NOT_FOUND: The license file could not be found or the access was denied. AIDA_boLoadLicenseFile() has not been called without error code EOSAL_LICENSE_NOT_FOUND before.
  EOSAL_STRING_OVERFLOW: The buffer size is too small to save all the license data.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Linux: Requires a kernel supporting ELF binaries.
  Header: Declared in bsk_aida.h, also requires portab.h.
  Import Library (Windows): Use BSK_AIDA.lib.

See Also

AIDA Overview, AIDA Stacks Licensing/Authentication Overview, AIDA Functions
Other Licensing/Authentication Functions: AIDA_boLoadLicenseFile, AIDA_boGetSeedForApplicationAuthentication, AIDA_boAuthenticateApplication
Directly Affected Stack Manipulation Functions: AIDA_hCreateStack, AIDA_hCreateStackEx, AIDA_hRestoreStack, AIDA_hRestoreStackRaw, AIDA_hRestoreStackEx, AIDA_bAddToStack