UnlockModule Method

Summary
Unlocks a specific module, or group of modules (depending on the serial number, or Key).

Note

As of v21 the LEADTOOLS Multimedia toolkit has been updated to use a seamless license mechanism and any new development must use it. The new licensing mechanism uses RasterSupport.SetLicense. For a step-by-step tutorial on a .NET platform, refer to Add References and Set a License.

The UnlockModule mechanism is still supported in v21.


Syntax
C#
C++/CLI
public static void UnlockModule( 
   string unlockKey, 
   LockType type, 
   string appId 
) 
public: 
static void UnlockModule(  
   String^ unlockKey, 
   LockType type, 
   String^ appId 
)  

Parameters

unlockKey
A string that represents the module serial number. This parameter cannot be NULL (empty).

type
The LockType enumeration value that specifies the level at which the unlocking operation will be performed.

appId
If type contains LockType.Application or LockType.Computer: The application ID; a unique ID of the calling application. The caller is responsible for uniqueness of this ID. It is recommended to use the full path of the application.

If Flags contains LockType.ApplicationPath: The application full path of the application (the long version, not the short 8.3 version of the path).

This parameter cannot be NULL (empty).

Remarks

Use this method to change the state for the modules that are unlocked to Release. Please note the following:

  • The Key is a unique module serial number that must be purchased from LEAD.
  • It may be necessary to call the function several times to unlock several modules (or filters/codecs).
  • Each module has its own key, but some keys can unlock more than one filter/module.
  • The AppID is used to uniquely identify the calling application. The AppID must be set to the application path if you unlock using LockType.ApplicationPath.

You should call LockModules when the app exits or is uninstalled.

Example
C#
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
 
public void MultimediaSupportExample() 
{ 
   // pszKey is a string containing the serial number. It is defined like this: 
   // string pszKey = "MySerial"; 
   string pszAppId = "My Test Application"; 
 
   try 
   { 
      // unlock the multimedia feature 
      Leadtools.Multimedia.Common.MultimediaSupport.UnlockModule(pszKey, 
                                                                 Leadtools.Multimedia.Common.LockType.Application, 
                                                                 pszAppId); 
   } 
   catch 
   { 
      return; 
   } 
 
   // [use the multimedia feature here] 
 
   // lock the multimedia feature before exiting the app 
   try 
   { 
      Leadtools.Multimedia.Common.MultimediaSupport.LockModules(Leadtools.Multimedia.Common.LockType.Application, 
                                                                pszAppId); 
   } 
   catch 
   { 
      return; 
   } 
   _result = true; 
} 
Requirements

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.