AIDA_boLoadLicenseFile

The AIDA_boLoadLicenseFile function load an AIDA license file and validates its signature and filename and checks the license expiration date and the licensing of the calling application.

bool AIDA_boLoadLicenseFile(
  const xchar *xsLicFileName
);

Parameters

xsFileName

Filename of the license file to be used. The filename has to be a full path of an existing file on the target operating system. It has to be passed with the extension .LIC.

Return Values

AIDA_boLoadLicenseFile returns true only if the license file can be read successfully, its signature and filename are correct, the license is not expired, no license configuration data is missing or malformed and if AIDA is licensed for the calling application/process.

If the function fails, the returned value is false. The application can retrieve the error code using AIDA_iGetError(). In case that EOSAL_LICENSE_NOT_FOUND is not set, the license info can be accessed using AIDA_boGetLicenseInfo(). Possible licensing-specific error codes set by this function are:
  EOSAL_ALREADY_INITIALIZED: The license file has already been opened by a previous call of AIDA_boLoadLicenseFile().
  EOSAL_LICENSE_NOT_FOUND: The license file could not be found or the access is denied.
  EOSAL_LICENSE_INVALID: The licence signature or the licence file name are invalid.
  EOSAL_BAD_CONFIGURATION: The license file does not contain all required data.
  EOSAL_LICENSE_EXPIRED: The licence file is expired.
  EOSAL_BAD_CONFIGURATION: The seed/key parameter index is invalid or other required license data is missing or malformed.
  EOSAL_APPL_OR_PIMOD_NOT_LICENSED: AIDA is not licensed for the calling application.

Remarks

The signature which is given in the license file in section [Key] must be matching the license configuration in section [Configuration].

The real filename of the license file must be identical (case-insensitive) with the name specified in section [Configuration] with key LicFileName.

The base name of the process which is calling this function must be listed in the license file in section [Configuration] as key Application with 1 of the possible 4 following values: YES, ON, TRUE or 1. E.g. ApplicationAIDA_Stacker = YES or ApplicationAIDA_Tracer = ON

Attention: If the license file is loaded successfully the file will be held open until the calling application is terminated resp. until the BSK_AIDA.dll is deinitialized.

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_boGetLicenseInfo, AIDA_boGetSeedForApplicationAuthentication, AIDA_boAuthenticateApplication
Directly Affected Stack Manipulation Functions: AIDA_hCreateStack, AIDA_hCreateStackEx, AIDA_hRestoreStack, AIDA_hRestoreStackRaw, AIDA_hRestoreStackEx, AIDA_bAddToStack