LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
UnlockModule Method
See Also 
Leadtools.Multimedia.Common Namespace > MultimediaSupport Class : UnlockModule Method



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).

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).

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

Syntax

Visual Basic (Declaration) 
Public Shared Sub UnlockModule( _
   ByVal unlockKey As String, _
   ByVal type As LockType, _
   ByVal appId As String _
)
Visual Basic (Usage)Copy Code
Dim unlockKey As String
Dim type As LockType
Dim appId As String
 
MultimediaSupport.UnlockModule(unlockKey, type, appId)
C# 
public static void UnlockModule( 
   string unlockKey,
   LockType type,
   string appId
)
C++/CLI 
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).

Example

Visual BasicCopy Code
Public _result As Boolean = False
Public Sub MultimediaSupportExample()
       ' pszKey is a string containing the serial number. It is defined like this:
   ' Private pszKey As String = "MyString"
   Dim pszAppId As String = "My Test Application"

   Try
      ' unlock the multimedia feature
      Leadtools.Multimedia.Common.MultimediaSupport.UnlockModule(pszKey, Leadtools.Multimedia.Common.LockType.Application, pszAppId)
   Catch
      Exit Sub
   End Try

   ' [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)
      _result = True
   Catch e1 As Exception
      _result = False
   End Try
End Sub
C#Copy Code
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;
}

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 MultimediaSupport.LockModules when the app exits or is uninstalled.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also