Platforms to show: All Mac Windows Linux Cross-Platform
Back to HASPHLDMBS class.
HASPHLDMBS.Available as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Dongle | MBS Dongle Plugin | 17.2 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns true if library was loaded successfully or we use internal library.
HASPHLDMBS.Detach(detachAction as string, scope as string, VendorCode as string, recipient as string, byref info as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Dongle | MBS Dongle Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
You do not need to be logged in to a Sentinel HASP Feature in order to use this function.
This function is used to detach a license for a Product (i.e. all Sentinel HASP Features and Memory files which belong to this Product) from a HASP SL Protection key. The function returns a H2R file which must then be applied on the recipient machine using hasp_update() or the ACC.
This function only works with HASP SL Protection Keys; HASP HL Protection Keys are ignored.
This function can also be used on the recipient machine to cancel an attached license. In this case, the recipient parameter is ignored and should be set to NULL. For cancelling, the function returns a R2H file which must be applied on the host machine using hasp_update() or the ACC. If the detached Product is already expired, no R2H file will be returned.
The required Vendor Codes are stored in a VendorCodes folder in your system. Without the correct Vendor Code, the function call cannot succeed.
Parameter | Description |
detachAction: | Parameters for the operation, in XML format. For more information, see the accompanying Sentinel HASP Run-time API help documentation. |
scope: | Search parameters for the Product that is to be detached |
VendorCode: | The Vendor Code. |
recipient: | Definition in XML format of the recipient computer, on which the detached Product will be installed. This information can be retrieved using either GetInfo or GetSessionInfo together with the format specifier HASP_RECIPIENT. Set to "" if an attached protection key is cancelled. |
info: | The information that is retrieved, in XML format. This information is a V2C, which can then be installed on the recipient computer via Update. |
Return code | Description |
HASP_STATUS_OK | Request was successfully completed |
HASP_INV_DETACH_ACTION | Invalid XML "detach_action" parameter |
HASP_INV_RECIPIENT | Invalid XML "recipient" parameter |
HASP_TOO_MANY_PRODUCTS | Scope for Detach does not specify a unique Parameter |
HASP_TOO_MANY_USERS | Too many users currently connected, or: at least one detachable Feature does not have enough network seats available |
HASP_ACCESS_DENIED | Request cannot be processed due to ACC restrictions |
HASP_FEATURE_EXPIRED | All detachable Features are expired |
HASP_INV_PRODUCT | Invalid Product information |
HASP_INV_DURATION | In the case of a new detachable license, duration exceeds maximum allowed OR, in the case of a detachable license extension, expiration date earlier than original date or too short (if an existing detached Product is extended, and the new expiration date is earlier than the original expiration date) |
HASP_INSUF_MEM | Out of memory |
HASP_DEVICE_ERR | Input/Output error in HASP SL secure storage, OR in case of a HASP HL key,USB communication error |
HASP_LOCAL_COMM_ERR | Communication error between API and local HASP License Manager |
HASP_REMOTE_COMM_ERR | Communication error between local and remote HASP License Manager |
HASPHLDMBS.GetInfo(scope as string, format as string, VendorCode as string, byref info as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Dongle | MBS Dongle Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
You do not need to be logged in to a Sentinel HASP Feature in order to use this function.
This function is used to specify conditions about where to search for information. In addition, it enables you to specify conditions about the format in which the retrieved information is presented. If retrieved information is appropriately formatted, it can be used as a template in the Constructor.
The requisite Vendor Codes are stored in a VendorCodes folder in your system. Without the correct Vendor Code, the function call cannot succeed.
This function cannot be used to retrieve legacy HASP Features.
scope: Definition of the data that is to be searched, in XML format. For more information, see the accompanying Sentinel HASP Run-time API help documentation
format: Definition of the format in which the data is to be displayed, in XML format. For more information, see the accompanying Sentinel HASP Run-time API help documentation.
VendorCode: the Vendor Code
info: The information that is retrieved, in XML format
Return Code | Description |
HASP_STATUS_OK | Request was successfully completed |
HASP_SCOPE_RESULTS_EMPTY | Unable to locate a Feature matching the scope |
HASP_INSUF_MEM | Out of memory |
HASP_INV_VCODE | Invalid Vendor Code |
HASP_UNKNOWN_VCODE | Vendor Code not recognized |
HASP_INVALID_PARAMETER | Scope or format string too long (max. length 32 kb) |
HASP_DEVICE_ERR | Input/Output error in HASP SL secure storage, OR in case of a HASP HL key, USB communication error |
HASP_LOCAL_COMM_ERR | Communication error between API and local HASP License Manager |
HASP_REMOTE_COMM_ERR | Communication error between local and remote HASP License Manager |
HASP_INV_FORMAT | Unrecognized format string |
HASP_INV_SCOPE | Unrecognized scope string |
HASP_BROKEN_SESSION | Session has been interrupted |
HASPHLDMBS.GetVersion(byref MajorVersion as Integer, byref MinorVersion as Integer, byref BuildServer as Integer, byref BuildNumber as Integer, VendorCode as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Dongle | MBS Dongle Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns error code.
HASPHLDMBS.LoadLibrary(file as folderitem) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Dongle | MBS Dongle Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns true on success and false on failure.
Loads a Windows DLL, a Linux shared library, a Mac OS X shared library or a Mac OS X framework from the given path.
See also:
HASPHLDMBS.LoadLibrary(path as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Dongle | MBS Dongle Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns true on success and false on failure.
Path can be an absolute, a relative or just a file name.
Loads a Windows DLL, a Linux shared library, a Mac OS X shared library or a Mac OS X framework from the given path.
See also:
HASPHLDMBS.Transfer(action as string, scope as string, VendorCode as string, recipient as string, byref info as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Dongle | MBS Dongle Plugin | 15.4 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Sentinel Licensing API Usage Notes
You do not need to be logged in to a Sentinel Feature in order to use this function.
This function is used to perform the following task as per its
"action" parameter.
for "detach" action: detach a license for a Product (i.e. all Sentinel Features and Memory files which belong to this Product) from a Sentinel SL/SL-AdminMode/SL-UserMode key. The function returns a bufferwhich should be saved as H2R file.
for "cancel" action: This action runs on the recipient machine to cancel an attached license. In this case, the
recipient parameter is ignored and should be set to "". For cancelling, the function returns a buffer which must be applied on the host machine using Update() or ACC If the detached Product is already expired, no buffer will be returned.
for "rehost" action: create a tranferable a license for given container (i.e. all Sentinel Features and Memory files
which belong to this container) from SL-AdminMode/SL-UserMode Protection key. The function returns buffer on success which must be saved as V2C file. Update() or ACC is used to apply this on destination machine.
This function only works with Sentinel SL/SL-AdminMode/SL-UserMode Protection Keys; Sentinel HL Protection Keys are ignored.
The required Vendor Codes are stored in a VendorCodes folder in your system. Without the correct Vendor Code, the function call cannot succeed.
action: Parameters for the operation, in XML format. For more information, see the accompanying Sentinel Licensing API help documentation.
scope: Search parameters for the conatiner-id that is to be re-hosted. For more information, see the accompanying
Sentinel Licensing API help documentation.
VendorCode: The Vendor Code
recipient: Definition in XML format of the recipient computer, on which the detached Product will be installed.
This information can be retrieved using either GetInfo or GetSessionInfo together with the format specifier
info: String for the information that is retrieved, in XML format. This information is a V2C, which can then be installed on the destination computer via Update.
The items on this page are in the following plugins: MBS Dongle Plugin.