Click or drag to resize
LicenseError Class
Class used for licensing errors, which may occur in a variety of operations performed by this library.
Inheritance Hierarchy
SystemObject
  com.softwarekey.Client.LicensingLicenseError

Namespace: com.softwarekey.Client.Licensing
Assembly: PLUSManaged (in PLUSManaged.dll) Version: 5.18.1.0
Syntax
public class LicenseError

The LicenseError type exposes the following members.

Constructors
  NameDescription
Public methodLicenseError
Creates a new LicenseError object.
Public methodLicenseError(Int32)
Creates a new LicenseError object with the specified error.
Public methodLicenseError(Int32, Exception)
Creates a new LicenseError object with a given error number and exception
Public methodLicenseError(Int32, Int32)
Creates a new LicenseError object with a specified error and extended error
Public methodLicenseError(Int32, Int32, Exception)
Creates a new LicenseError object with a given error number, extended error number, and exception
Top
Properties
  NameDescription
Public propertyErrorException
The Exception associated with the error (may be null).
Public propertyErrorNumber
The error number/code.
Public propertyErrorString
The human-readable description of the error.
Public propertyExtendedErrorNumber
The extended error number/code. This may be returned by an external source, such as a SOLO Server web service.
Top
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberGetWebServiceErrorMessage(Int32)
Gets a friendly web service error message for display.
Public methodStatic memberGetWebServiceErrorMessage(LicenseError)
Gets a friendly web service error message for display.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString
Gets a human-readable description of the error (exactly the same as the value given by the ErrorString property).
(Overrides ObjectToString.)
Top
Fields
  NameDescription
Public fieldStatic memberERROR_CONTEXT_INVALID
Error number for when the API context is invalid.
Public fieldStatic memberERROR_COULD_NOT_DELETE_FILE
Error number for when an attempt to delete a license file failed.
Public fieldStatic memberERROR_COULD_NOT_LOAD_LICENSE
Error number for when an attempt to load a license file failed.
Public fieldStatic memberERROR_COULD_NOT_LOAD_VOLUME_DOWNLOADABLE_LICENSE
Error number for when an attempt to load a volume or downloadable license file failed.
Public fieldStatic memberERROR_COULD_NOT_OPEN_FILE
Error number for when an attempt to open a file failed.
Public fieldStatic memberERROR_COULD_NOT_OPEN_REGISTRY_KEY
Error number for when an attempt to open a registry key failed.
Public fieldStatic memberERROR_COULD_NOT_READ_FILE
Error number for when an attempt to read a file failed.
Public fieldStatic memberERROR_COULD_NOT_READ_PERMISSIONS
Error number for when an attempt to read a file or registry key's permissions failed.
Public fieldStatic memberERROR_COULD_NOT_READ_REGISTRY_KEY
Error number for when an attempt to read a registry key value failed.
Public fieldStatic memberERROR_COULD_NOT_SAVE_LICENSE
Error number for when an attempt to save a new license file failed.
Public fieldStatic memberERROR_COULD_NOT_SAVE_NETWORK_CERTIFICATE
Error number for when an attempt to save a NetworkSessionCertificate file failed.
Public fieldStatic memberERROR_COULD_NOT_SET_PERMISSIONS
Error number for when an attempt to set a file or registry key's permissions failed.
Public fieldStatic memberERROR_COULD_NOT_WRITE_FILE
Error number for when an attempt to write a file failed.
Public fieldStatic memberERROR_COULD_NOT_WRITE_REGISTRY_KEY
Error number for when an attempt to write a registry key value failed.
Public fieldStatic memberERROR_DATETIME_CONVERSION_FAILED
Error number for when a date-time conversion operation fails.
Public fieldStatic memberERROR_DECRYPTION_FAILED
Error number for when decrypting a document fails.
Public fieldStatic memberERROR_ENCRYPTION_FAILED
Error number for when encrypting a document fails.
Public fieldStatic memberERROR_ENVELOPE_TYPE_INVALID
The envelope is not valid or not for application use.
Public fieldStatic memberERROR_HTTP_CONNECTION_FAILED
Error number for when an HTTP connection fails.
Public fieldStatic memberERROR_HTTP_COULD_NOT_RESOLVE_HOST
Error number for when the specified host could not be resolved.
Public fieldStatic memberERROR_HTTP_INITIALIZATION_FAILED
Error number for when the HTTP client fails to initialize.
Public fieldStatic memberERROR_INSTALLATIONID_REQUIRED
An Installation ID is required, but not present.
Public fieldStatic memberERROR_INSUFFICIENT_IMAGE_SIZE
The license image is either too small to hold the license data or is under the minimum image size required.
Public fieldStatic memberERROR_INVALID_ARGUMENTS
Error number for when some or all of the function arguments are invalid.
Public fieldStatic memberERROR_INVALID_CLIENT_KEY
Error number for when an invalid client key is provided.
Public fieldStatic memberERROR_INVALID_DATA
Error number for when invalid data is provided.
Public fieldStatic memberERROR_INVALID_IMAGE
The license image is not valid.
Public fieldStatic memberERROR_INVALID_LICENSE_TYPE
Error number for when a license type is invalid or not supported.
Public fieldStatic memberERROR_INVALID_PRODUCTID
The Product ID authorized in the license is invalid or not for this application.
Public fieldStatic memberERROR_INVALID_PRODUCTOPTIONID
The Product Option ID authorized in the license is invalid or not for this application.
Public fieldStatic memberERROR_INVALID_SERVER_KEY
Error number for when an invalid server key is provided.
Public fieldStatic memberERROR_IO_OPERATION_FAILED
Error number when an attempt to perform an I/O operation failed.
Public fieldStatic memberERROR_LIBRARY_FUNCTION_UNAVAILABLE
Error number for when a required library function is missing.
Public fieldStatic memberERROR_LIBRARY_UNAVAILABLE
Error number for when a required system library is missing for failed to load.
Public fieldStatic memberERROR_LICENSE_ALIAS_VALIDATION_FAILED
Error number for when an alias's LastUpdated date could not be validated.
Public fieldStatic memberERROR_LICENSE_ALIAS_VALIDATION_TIME_MISMATCH
Error number for when an alias has a LastUpdated date in the future.
Public fieldStatic memberERROR_LICENSE_EXPIRED
Error number for when the license is expired.
Public fieldStatic memberERROR_LICENSE_NOT_EFFECTIVE_YET
Error number for when the license is not effective yet.
Public fieldStatic memberERROR_LICENSE_SYSTEM_IDENTIFIERS_DONT_MATCH
Error number for when system identifiers do not match.
Public fieldStatic memberERROR_MEMORY_ALLOCATION
Error number for when an attempt to allocate memory fails.
Public fieldStatic memberERROR_MODULE_NOT_ACTIVE
Error number for when use of the application or module is not permitted.
Public fieldStatic memberERROR_NETWORK_CERTIFICATE_INVALID_PATH
Error number for when a NetworkSessionCertificate file's path is invalid.
Public fieldStatic memberERROR_NETWORK_CERTIFICATE_REQUIRED
Error number for when a NetworkSessionCertificate is not present, but is required.
Public fieldStatic memberERROR_NETWORK_LICENSE_FULL
Error number for when the number of allowed concurrent users has been reached.
Public fieldStatic memberERROR_NETWORK_SEMAPHORE_INVALID_PATH
Error number for when a NetworkSemaphore file's path is invalid.
Public fieldStatic memberERROR_NETWORK_SEMAPHORE_LOCK_FAILED
Error number for when network semaphore file creation fails.
Public fieldStatic memberERROR_NONE
Error number for when there is no error.
Public fieldStatic memberERROR_PLATFORM_ERROR
Error number for when a platform specific API or system call fails.
Public fieldStatic memberERROR_PLUS_EVALUATION_INVALID
The Protection PLUS 5 SDK evaluation is invalid or expired.
Public fieldStatic memberERROR_PLUS_EVALUATION_WARNING
No error actually occurred, but that an evaluation envelope is being used.
Public fieldStatic memberERROR_REMOTE_SESSION_DETECTED
Error number for when a remote session is detected.
Public fieldStatic memberERROR_REQUIRED_SERVER_VALIDATION_FAILED
Error number for when a any kind of validation against SOLO Server is required, but could not be completed.
Public fieldStatic memberERROR_SESSION_VERIFICATION_FAILED
Error number for when session code verification fails.
Public fieldStatic memberERROR_SIGNING_FAILED
Error number for when signing a document fails.
Public fieldStatic memberERROR_SSL_CERTIFICATE_EXPORT_FAILED
Error number for when an attempt to export the SSL certificate bundle failed.
Public fieldStatic memberERROR_SSL_CERTIFICATE_UNAVAILABLE
Error number for when an HTTPS request fails due to a problem with the certificate bundle.
Public fieldStatic memberERROR_SSL_FAILED
Error number for when an HTTPS request fails due to an SSL related problem.
Public fieldStatic memberERROR_STRING_CONVERSION_FAILED
Error number for when a string conversion operation fails.
Public fieldStatic memberERROR_SYSTEM_TIME_INVALID
Error number for when the system time is invalid.
Public fieldStatic memberERROR_SYSTEM_TIME_VERIFICATION_FAILED
Error number for when system time verification failed.
Public fieldStatic memberERROR_TRIGGER_CODE_EVENT_DATA_INVALID
Error number for when an invalid "Activation Code 2" value is entered by the user.
Public fieldStatic memberERROR_TRIGGER_CODE_INVALID
Error number for when an invalid "Activation Code 1" value is entered by the user.
Public fieldStatic memberERROR_UNSUPPORTED_OS
Error number for when an attempt to perform an unsupported operation occurs.
Public fieldStatic memberERROR_VERIFICATION_FAILED
Error number for when verifying the signature of a document fails.
Public fieldStatic memberERROR_VIRTUAL_MACHINE_DETECTED
Error number for when a virtual machine is detected.
Public fieldStatic memberERROR_WEBSERVICE_CALL_FAILED
Error number for when a web service call failed.
Public fieldStatic memberERROR_WEBSERVICE_INVALID_CONFIGURATION
Error number for when an invalid web service configuration is provided.
Public fieldStatic memberERROR_WEBSERVICE_RETURNED_FAILURE
Error number for when a web service call returned an error.
Public fieldStatic memberERROR_XML_NODE_MISSING
Error number for when the specified node is not present in the document.
Public fieldStatic memberERROR_XML_PARSER_FAILED
Error number for when the XML parser fails.
Top
Remarks

Throughout the PLUSManaged library, a common paradigm in its objects is to return a Boolean value to indicate success (true) or some kind of failure (false). When a failure is indicated, a LicenseError object may typically be referenced (through a "LastError" property) to obtain more details on the failure. The type of failure can be uniquely identified via the ErrorNumber property, and the description of this error is available through the ErrorString property. Additionally, when the failure occurs within this library and involves an Exception, the ErrorException property contains the Exception object.

When the operation which generated a failure is processed through a system outside of this library (such as a a call to a SOLO Server web service method), the ExtendedErrorNumber property is populated with that system's error number or result code. In the case of a call to SOLO Server web service methods, the GetWebServiceErrorMessage(Int32) method may be used to retrieve a description of the error.

See Also