 |
Zentitle SDK and Library
|
|
Zentitle SDK and Library
|
Modules | |
| Nalpeiron Passive licensing error returns | |
Files | |
| file | cpsl.py |
| Nalpeiron V10 Nalpeiron Passive library licensing (PSL) functions. | |
Functions | |
| def | cpsl.PSLDefineFunctions (oset, libHandle) |
| Define the Passive Licenseing library (PSL) functions from the C library. More... | |
| def | cpsl.pyPSLLibOpen (initXMLString) |
| Initializes the Nalpeiron C library for use. More... | |
| def | cpsl.pyPSLLibClose () |
| Closes the Nalpeiron library after use. More... | |
| def | cpsl.pyPSLGetErrorMsg (nalpErrorNo) |
| Get a descriptive string for nalpeiron error codes. More... | |
| def | cpsl.pyPSLImportLicense (licenseCode, licenseContainer) |
| Import a license. More... | |
| def | cpsl.pyPSLValidateLibrary (custID, prodID) |
| Verifies that the shared library you are accessing is the library you stamped at Nalpeiron's website. More... | |
| def | cpsl.pyPSLGetComputerID () |
| Gets the computer ID of the current system. More... | |
| def | cpsl.pyPSLGetVersion () |
| Gets the version of the NSL library being accessed. More... | |
| def | cpsl.pyPSLGetLeaseExpSec () |
| Retrieves the number of epoch seconds (seconds from Jan 1 1970) until the license lease expiration. More... | |
| def | cpsl.pyPSLGetLeaseExpDate () |
| Retrieves the expiration of the license as a time/date string (Wed Jul 17 19:59:12 2013, for example). More... | |
| def | cpsl.pyPSLGetMaintExpSec () |
| Retrieves the number of epoch seconds (seconds from Jan 1 1970) until the maintenance period expiration. More... | |
| def | cpsl.pyPSLGetMaintExpDate () |
| Retrieves the expiration of the maintenance period as a time/date string (Wed Jul 17 19:59:12 2013, for example). More... | |
| def | cpsl.pyPSLGetLicenseStatus () |
| Retrieves the status of the current license. More... | |
| def | cpsl.pyPSLGetLicenseCode () |
| Retrieves the license code used with the current license. More... | |
| def | cpsl.pyPSLGetNumbAvailProc () |
| A license may limit the number of simultaneous copies allowed to run on a specific computer. More... | |
| def | cpsl.pyPSLGetFeatureStatus (featureCode) |
| Checks the current license for the status of featureName. More... | |
| def | cpsl.pyPSLGetUDFValue (udfName) |
| Retrieve the value of a UDF (AA) More... | |
Variables | |
| int | cpsl.offset = 0 |
| def cpsl.PSLDefineFunctions | ( | oset, | |
| libHandle | |||
| ) |
Define the Passive Licenseing library (PSL) functions from the C library.
| oset | Security offset as calculated in nalpParse.py (/ref _secOffset) |
| libHandle | a library handle as returned by cytpes.cdll.LoadLibrary |
| def cpsl.pyPSLGetComputerID | ( | ) |
Gets the computer ID of the current system.
| def cpsl.pyPSLGetErrorMsg | ( | nalpErrorNo | ) |
Get a descriptive string for nalpeiron error codes.
| nalpErrorNo | is a negative return value from one of the Nalpeiron functions |
| def cpsl.pyPSLGetFeatureStatus | ( | featureCode | ) |
Checks the current license for the status of featureName.
Status if returned in featureStatus.
| featureCode | a string containing the five (5) character feature code of the feature to be checked out. |
| def cpsl.pyPSLGetLeaseExpDate | ( | ) |
Retrieves the expiration of the license as a time/date string (Wed Jul 17 19:59:12 2013, for example).
| def cpsl.pyPSLGetLeaseExpSec | ( | ) |
Retrieves the number of epoch seconds (seconds from Jan 1 1970) until the license lease expiration.
If the item has expired, the number of seconds remaining will be zero. epochDate is the absolute expiration date in epoch sec. If epochDate = NULL then no epochDate value is retrieved.
| def cpsl.pyPSLGetLicenseCode | ( | ) |
Retrieves the license code used with the current license.
NOTE: a license code will only be present if one has already been assigned to the current license via NSLGetLicense, NSLImportCert, etc.
| def cpsl.pyPSLGetLicenseStatus | ( | ) |
Retrieves the status of the current license.
Negative values indicate an invalid license state.
| def cpsl.pyPSLGetMaintExpDate | ( | ) |
Retrieves the expiration of the maintenance period as a time/date string (Wed Jul 17 19:59:12 2013, for example).
| def cpsl.pyPSLGetMaintExpSec | ( | ) |
Retrieves the number of epoch seconds (seconds from Jan 1 1970) until the maintenance period expiration.
If the item has expired, the number of seconds remaining will be zero. epochDate is the absolute expiration date in epoch sec. If epochDate = NULL then no epochDate value is retrieved.
| def cpsl.pyPSLGetNumbAvailProc | ( | ) |
A license may limit the number of simultaneous copies allowed to run on a specific computer.
This limit is disabled by default and, if desired, must be enabled on the Nalpeiron server. The number of copies available is set to noProcs+1 and availProc is the number of copies still available for use. When an application instance is started and returns availProc=0, the number of instances exceeds the maximum allowed and this instance should be terminated.
When disabled, this fuction will always return zero (0) as noProcs and one (1) as the number of availProc. NOTE limiting the number of processes allowed on a machine ("Number of concurrent Processes" setting on server) is not affected by the "Concurrency Mode" setting.
| def cpsl.pyPSLGetUDFValue | ( | udfName | ) |
Retrieve the value of a UDF (AA)
| udfName | a string containing the five (5) character UDF code of the value to be accessed |
| def cpsl.pyPSLGetVersion | ( | ) |
Gets the version of the NSL library being accessed.
| def cpsl.pyPSLImportLicense | ( | licenseCode, | |
| licenseContainer | |||
| ) |
Import a license.
| licenseCode | contains the current license code. licenseCode should be freed with PSLFree. |
| licenseContainer | Either the license itself passed in as a NULL terminated string or the full path to a file containing the license. |
| def cpsl.pyPSLLibClose | ( | ) |
Closes the Nalpeiron library after use.
| def cpsl.pyPSLLibOpen | ( | initXMLString | ) |
Initializes the Nalpeiron C library for use.
See parameter details in nalpparse.py
| initXMLString | a valid XML string containing initialization parameters (see nalpparse.py for details) |
| def cpsl.pyPSLValidateLibrary | ( | custID, | |
| prodID | |||
| ) |
Verifies that the shared library you are accessing is the library you stamped at Nalpeiron's website.
It does this by checking the customerID and productID sent in against the stamped values. Any negative return value, even if it is not a known error code, is cause to consider the library invalid.
| custID | a unsigned 32 bit integer containing your Nalpeiron customer ID. NOTE the library uses ONLY the last 5 non-zero digits of your full customer ID. That is, if your customer ID is 12340005678 then the customer ID used in conjuction with the library would be 5678. |
| prodID | a unsigned 32 bit integer containing your Nalpeiron product ID. NOTE the library uses ONLY the last 5 non-zero digits of your full product ID. That is, if your customer ID is 12340005678 then the product ID used in conjuction with the library would be 5678. |
| int cpsl.offset = 0 |
1.8.9.1
