Platforms to show: All Mac Windows Linux Cross-Platform

Back to UnikeyMBS class.

Next items

UnikeyMBS.Calculate1(StartAddress as Integer, Module as Integer, byref RegA as Integer, byref RegB as Integer, byref RegC as Integer, byref RegD as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Return the results of a calculation performed in UniKey, using input provided by the developer and the CALCULATE1 function.

See Unikey API Reference for details on UniKey_Calculate1 function.
Returns error code.

Some examples using this method:

UnikeyMBS.Calculate2(StartAddress as Integer, Seed as Integer, byref RegA as Integer, byref RegB as Integer, byref RegC as Integer, byref RegD as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Return the results of a calculation performed in UniKey, using input provided by the developer and the CALCULATE2 function.

See Unikey API Reference for details on UniKey_Calculate2 function.
Returns error code.

Some examples using this method:

UnikeyMBS.Calculate3(StartAddress as Integer, Module as Integer, byref RegA as Integer, byref RegB as Integer, byref RegC as Integer, byref RegD as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Return results of a calculation performed in UniKey, using input provided by the developer and the CALCULATE3 function.

See Unikey API Reference for details on UniKey_Calculate3 function.
Returns error code.

Some examples using this method:

UnikeyMBS.CheckModule(Module as Integer, byref Value as Integer, byref Decrease as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Read the attributes of a specific UniKey license module.

See Unikey API Reference for details on UniKey_Check_Module function.
Returns error code.

UnikeyMBS.CheckTimeModule(Module as Integer, byref RemainDays as Integer, Year as Integer, Month as Integer, Day as Integer, Hour as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Read the attributes of a specific UniKey Time license module.

See Unikey API Reference for details on UniKey_Check_Time_Module function.
Returns error code.

UnikeyMBS.CheckTimeModuleNow(Module as Integer, byref RemainDays as Integer, byref RemainHours as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Read the attributes of a specific UniKey Time license module now.

See Unikey API Reference for details on UniKey_Check_Time_Module_Now function.
Returns error code.

UnikeyMBS.CheckTimeModuleNowPC(Module as Integer, byref RemainDays as Integer, byref RemainHours as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Read the attributes of a specific UniKey Time license module Now PC.

See Unikey API Reference for details on UniKey_Check_Time_Module_Now_PC function.
Returns error code.

UnikeyMBS.Decrypt(BufferLength as Integer, KeyNumber as Integer, Buffer as Ptr) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Decrypt an amount of memory with a key.

The length of data must be a multiple of 8.
See Unikey API Reference for details on UniKey_Decrypt function.
Returns error code.

UnikeyMBS.Encrypt(BufferLength as Integer, KeyNumber as Integer, Buffer as Ptr) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Encrypt an amount of memory with a key.

The length of data must be a multiple of 8.
See Unikey API Reference for details on UniKey_Encrypt function.
Returns error code.

UnikeyMBS.EraseTimeModule(Module as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Erase/Reset a real time module, and all the info in the module will be erased including start, end or duration.

See Unikey API Reference for details on UniKey_Erase_Time_Module function.
Returns error code.

UnikeyMBS.Find(byref Setting1 as Integer, byref Setting2 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Check if a specific UniKey is attached to the USB port.

This is the first API to start a UniKey session.
Sets handle property.

See Unikey API Reference for details on UniKey_Find function.

UnikeyMBS.FindNext(byref Setting1 as Integer, byref Setting2 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Check if another UniKey is attached to the USB port.

Sets the handle property.
Returns error code.
See Unikey API Reference for details on UniKey_Find_Next function.

UnikeyMBS.GenerateKey(KeyNumber as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Generate a new key in the specific key storage.

See Unikey API Reference for details on UniKey_Generate_Key function.
Returns error code.

UnikeyMBS.GenerateKeyViaSeed(KeyNumber as Integer, byref Seed1 as Integer, byref Seed2 as Integer, byref Seed3 as Integer, byref Seed4 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Generate a new key in the specific key storage via seed.

See Unikey API Reference for details on UniKey_Generate_Key_Via_Seed function.
Returns error code.

UnikeyMBS.GenerateNewPassword(Seed as Integer, byref Password1 as Integer, byref Password2 as Integer, byref Password3 as Integer, byref Password4 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Generate a new password via a seed code; the mapping from the seed code to the password is only one way. Without the seed, you cannot generate the same password.

See Unikey API Reference for details on UniKey_Generate_New_Password function.
Returns error code.

UnikeyMBS.GetCliNum(byref Count as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the UniKey client number.

See Unikey API Reference for details on UniKey_Get_Cli_Num function.
Returns error code.

UnikeyMBS.GetDongleLocation(byref IP as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the Server IP, if it is local, return 127.0.0.1.

See Unikey API Reference for details on UniKey_Get_Dongle_Location function.
Returns error code.

UnikeyMBS.GetMaxNum(byref Count as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the maximum client number.

See Unikey API Reference for details on UniKey_Get_Max_Num function.
Returns error code.

UnikeyMBS.GetModule(Module as Integer, byref Value as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get a value from a specific UniKey license module.

See Unikey API Reference for details on UniKey_Get_Module function.
Returns error code.

UnikeyMBS.GetModuleEndTime(Module as Integer, byref Year as Integer, byref Month as Integer, byref Day as Integer, byref Hour as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Reads the end time of a specific UniKey Time license module.

See Unikey API Reference for details on UniKey_Get_Module_End_Time function.
Returns error code.

Not supported for 64-bit Linux and Mac PPC.

UnikeyMBS.GetModuleStartTime(Module as Integer, byref Year as Integer, byref Month as Integer, byref Day as Integer, byref Hour as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Reads the start time of a specific UniKey Time license module.

See Unikey API Reference for details on UniKey_Get_Module_Start_Time function.
Returns error code.

Not supported for 64-bit Linux and Mac PPC.

UnikeyMBS.GetTime(byref Year as Integer, byref Month as Integer, byref Day as Integer, byref Hour as Integer, byref Minute as Integer, byref Second as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get UniKey Time’s real time clock’s time.

See Unikey API Reference for details on UniKey_Get_Time function.
Returns error code.
Year is 10 for 2010.

UnikeyMBS.GetType(byref type as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
GetType can help you get the type of the UniKey dongle.

The return value of type will indicate the type of the UniKey dongle.
UNIKEY_TYPE_TIME 101
UNIKEY_TYPE_PRO 102
UNIKEY_TYPE_STD 103

See Unikey API Reference for details on UniKey_Get_Type function.

UnikeyMBS.GetVersion(byref Version as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the current UniKey library version.

See Unikey API Reference for details on UniKey_Get_Version function.
Returns error code.

UnikeyMBS.Lock as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Locks the unikey.

UnikeyMBS.Logoff as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Logoff a UniKey dongle with a specific handle.

This API should be called at the end of UniKey session.
See Unikey API Reference for details on UniKey_Logoff function.
Returns error code.

UnikeyMBS.MD5(BufferLength as Integer, Buffer as Ptr) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Make an MD5 digest for a mount of content or data.

See Unikey API Reference for details on UniKey_MD5 function.
Returns error code.

UnikeyMBS.ModuleDecrease(Module as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Decrease the value in a specified UniKey license module by “1”.

See Unikey API Reference for details on UniKey_Module_Decrease function.
Returns error code.

For Linux, does not work on Linux ARM or 32-bit Linux. Works on 64-bit Linux.

UnikeyMBS.Random(byref Return1 as Integer, byref Return2 as Integer, byref Return3 as Integer, byref Return4 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Generate a random number from the dongle.

See Unikey API Reference for details on UniKey_Random function.
Returns error code.

Some examples using this method:

UnikeyMBS.ReadMemory(StartAddress as Integer, BufferLength as Integer, Buffer as Ptr) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Read the contents of the Memory.

This API needs to be called after logon of a UniKey dongle.
See Unikey API Reference for details on UniKey_Read_Memory function.
Returns error code.

UnikeyMBS.ReadSoftID(byref SoftID as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Read the user defined SoftID.

See Unikey API Reference for details on UniKey_Read_SoftID function.
Returns error code.

UnikeyMBS.ReadUpdateTag(byref UpdateTag as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Read UpdateTag from a specific dongle.

See Unikey API Reference for details on UniKey_Read_UpdateTag function.
Returns error code.

UnikeyMBS.Seed(Seed as Integer, byref Return1 as Integer, byref Return2 as Integer, byref Return3 as Integer, byref Return4 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get return codes from the input of a seed code.

This API return for values which are related to Seed and UniKey dongle’s password.
See Unikey API Reference for details on UniKey_Seed function.
Returns error code.

UnikeyMBS.SetMaxNum(byref Count as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the maximum client number.

See Unikey API Reference for details on UniKey_Set_Max_Num function.
Returns error code.

Not supported for Mac PPC.

UnikeyMBS.SetModule(Module as Integer, Value as Integer, Decrease as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
To write a value to a specific UniKey license module and set the Decrement attribute.

See Unikey API Reference for details on UniKey_Set_Module function.
Returns error code.

UnikeyMBS.SetNETINILocation(byref Setting1 as Integer, byref Setting2 as Integer, IniFile as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Sets ini location.

See Unikey API Reference for details on UniKey_SetNETINILocation function.
Returns error code.

UnikeyMBS.SetTime(Year as Integer, Month as Integer, Day as Integer, Hour as Integer, Minute as Integer, Second as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set UniKey Time’s real time clock’s time.

See Unikey API Reference for details on UniKey_Set_Time function.
Returns error code.
Year is 10 for 2010.

UnikeyMBS.SetTimeModuleDuration(Module as Integer, Year as Integer, Day as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the duration time for a specific real time module. The total duration is (Day)*24 + (Hour) in hours.

See Unikey API Reference for details on UniKey_Set_Time_Module_Duration function.
Returns error code.

UnikeyMBS.SetTimeModuleEndTime(Module as Integer, Year as Integer, Month as Integer, Day as Integer, Hour as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set a real time module’s end time.

See Unikey API Reference for details on UniKey_Set_Time_Module_End_Time function.
Returns error code.

UnikeyMBS.SetTimeModuleStartTime(Module as Integer, Year as Integer, Month as Integer, Day as Integer, Hour as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set a real time module’s start time.

See Unikey API Reference for details on UniKey_Set_Time_Module_Start_Time function.
Returns error code.

UnikeyMBS.SetTimeModuleStartTimeNow(Module as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set a real time module’s start time as the now time in UniKey dongle’s clock.

See Unikey API Reference for details on UniKey_Set_Time_Module_Start_Time_Now function.
Returns error code.

UnikeyMBS.SetTimeModuleStartTimeNowPC(Module as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set a real time module’s start time as the now time in host computer.

See Unikey API Reference for details on UniKey_Set_Time_Module_Start_Time_Now_PC function.
Returns error code.

UnikeyMBS.SetTimeNow as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set UniKey Time’s real time clock’s time by the host computer’s clock.

See Unikey API Reference for details on UniKey_Set_Time_Now function.
Returns error code.

UnikeyMBS.Unikey(FunctionCode as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 7.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Calls the unikey function with the values from this object.

See the unikey documentation for what values to use.

Some examples using this method:

UnikeyMBS.UnLock as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Unlocks the unikey.

UnikeyMBS.UserLogon(Password1 as Integer, Password2 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Logon a UniKey dongle with specified passwords.

This API should be called in the released software in order to improve security.
See Unikey API Reference for details on UniKey_User_Logon function.
Returns error code.
Sets handle property.

Some examples using this method:

UnikeyMBS.VendorLogon(Password1 as Integer, Password2 as Integer, Password3 as Integer, Password4 as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ❌ No ❌ No Desktop, Console & Web
Logon a UniKey dongle in vendor mode with specified passwords.

This API helps software vendors to logon the UniKey dongle in vendor mode, and get the full permission to UniKey dongle.
We do NOT advise you to enclose this API in the final released software. This API is only for software vendor’s usage.
If password3 or password4 is wrong while password1 and password2 is correct, the dongle is also logged on in user mode automatically.

Sets handle property.
See Unikey API Reference for details on UniKey_Vender_Logon function.
Returns error code.

Not supported on Linux.

Some examples using this method:

UnikeyMBS.WriteArithmetic(StartAddress as Integer, Buffer as Ptr) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Write user-defined mathematical algorithms.

See Unikey API Reference for details on UniKey_Write_Arithmetic function.
Returns error code.

UnikeyMBS.WriteMemory(StartAddress as Integer, BufferLength as Integer, Buffer as Ptr) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Dongle MBS Dongle Plugin 16.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Write data into the memory.

This API needs to be called after logging on to a UniKey dongle.
See Unikey API Reference for details on UniKey_Write_Memory function.
Returns error code.

Next items

The items on this page are in the following plugins: MBS Dongle Plugin.


The biggest plugin in space...