License module

class License.License

Bases: SpireObject

Represents a license object.

static ClearLicense()

Clears all cached licenses.

static ClearLicenseByDLLHander(dllhander)

Clears all cached licenses using the DLL handler.

Parameters:

dllhander – The DLL handler.

static GetLicenseFileNameByDLLHander(dllhander) → str

Gets the current license file name using the DLL handler.

Parameters:

dllhander – The DLL handler.

Returns:

The license file name. The default license file name is [license.elic.xml].

static LoadLicense()

Loads the license provided by the current setting to the license cache.

static LoadLicenseByDLLHander(dllhander)

Loads the license using the DLL handler.

Parameters:

dllhander – The DLL handler.

static SetLicenseFileFullPath(licenseFileFullPath: str)

Provides a license by a license file path, which will be used for loading license.

Parameters:

licenseFileFullPath – The license file full path.

static SetLicenseFileFullPathByDLLHander(dllhander, licenseFileFullPath: str)

Sets the license file full path using the DLL handler.

Parameters:

  • dllhander – The DLL handler.

  • licenseFileFullPath – The license file full path.

static SetLicenseFileName(licenseFileName: str)

Sets the current license file name.

Parameters:

licenseFileName – The license file name. The default license file name is [license.elic.xml].

static SetLicenseFileNameByDLLHander(dllhander, licenseFileName: str)

Sets the license file name using the DLL handler.

Parameters:

  • dllhander – The DLL handler.

  • licenseFileName – The license file name.

static SetLicenseFileStream(stream: Stream)

Provides a license by a license stream, which will be used for loading license.

Parameters:

stream – The license data stream.

static SetLicenseFileStreamByDLLHander(dllhander, stream: Stream)

Sets the license file stream using the DLL handler.

Parameters:

  • dllhander – The DLL handler.

  • stream – The license data stream.

static SetLicenseKey(key: str)

Provides a license by a license key, which will be used for loading license.

Parameters:

key – The value of the Key attribute of the element License of your license xml file.

static SetLicenseKeyByDLLHander(dllhander, key: str)

Sets the license key using the DLL handler.

Parameters:

  • dllhander – The DLL handler.

  • key – The license key.