In This Topic ▼

ILMDSKernel2::UnlockModule

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 L_SetLicenseFile and L_SetLicenseBuffer. For a step-by-step tutorial on a C DLL platform, refer to Add References and Set a License.

The ILMDSKernel2::UnlockModule mechanism is still supported in v21.

Syntax

#include "ILMDSKernel2.h"

Language	Syntax
C	HRESULT ILMDSKernel2_UnlockModule(pDSKrn, Key, Flags, AppID)
C++	HRESULT UnlockModule(BSTR Key, long Flags, BSTR AppID)
VB	object.UnlockModule(Key As String, Flags As Long, AppID As String) As Long

Parameters

BSTR Key

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

long Flags

One of the UnLockFlagsConstants2 enumeration values that specify the level at which the unlocking operation will be performed.

BSTR AppID

If Flags contains UNLOCK_APP_ONCE or UNLOCK_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 UNLOCK_APP_PATH: 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).

Returns

Value	Meaning
S_OK	The function ran successfully.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the ShowDirectShow documentation.

Comments

Use this function 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 toolkits (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 UNLOCK_APP_PATH.
The UNLOCK_APP_ALWAYS has been deprecated. Currently, it has the same effect as UNLOCK_APP_ONCE and support for it might be dropped in the future. You should use UNLOCK_APP_PATH if you want to unlock a particular application.