#include "ILMDSKernel2.h"
C Syntax |
HRESULT ILMDSKernel2_UnlockModule(pDSKrn, Key, Flags, AppID) |
C++ Syntax |
HRESULT UnlockModule(BSTR Key, long Flags, BSTR AppID) |
VB Syntax |
object.UnlockModule(Key As String, Flags As Long, AppID As String) As Long |
ILMDSKernel2 *pDSKrn; |
/* pointer to an interface */ |
BSTR When "getting" a BSTR property, the memory containing the string is allocated with SysAllocString. When this string is no longer needed, free this memory by calling SysFreeString if you are working in an environment such as C or C++ that does not automatically delete the memory. VB automatically deletes the memory, so VB programmers do not need to free the memory themselves. Key; |
/* serial number */ |
long Flags; |
/* flags */ |
BSTR When "getting" a BSTR property, the memory containing the string is allocated with SysAllocString. When this string is no longer needed, free this memory by calling SysFreeString if you are working in an environment such as C or C++ that does not automatically delete the memory. VB automatically deletes the memory, so VB programmers do not need to free the memory themselves. AppID; |
/* calling application ID or path */ |
Unlocks a specific module, or group of modules (depending on the serial number, or Key).
Parameter |
Description |
pDSKrn |
Pointer to an ILMDSKernel2 interface. |
Key |
A string that represents the module serial number. This parameter cannot be NULL (empty). |
Flags |
One of the UnLockFlagsConstants2 enumeration values that specify the level at which the unlocking operation will be performed. |
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
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 app.
Required DLLs and Libraries
DSKernel2.dll |
See Also
Elements: |
Example
For an example, refer to Using the DSKernel Object.