Headers diff for slwga.dll between 6.1.7601.17514-Windows_7.0 and 6.3.9600.16384-Windows_8.1 versions



 slpublic.h (6.1.7601.17514-Windows_7.0)   slpublic.h (6.3.9600.16384-Windows_8.1) 
/*++ /*++
Copyright (C) Microsoft Corporation, 2006 Copyright (C) Microsoft Corporation, 2006
Module Name: Module Name:
slpublic.h slpublic.h
Abstract: Abstract:
Software Licensing and Geniune Advantage Client public API Software Licensing and Genuine Advantage Client public API
--*/ --*/
#pragma once #pragma once
#ifndef _SLPUBLIC_H_ #ifndef _SLPUBLIC_H_
#define _SLPUBLIC_H_ #define _SLPUBLIC_H_
#if defined(SPP_CODE_PROJECT_MARKER) || defined(SPP_CODE_PROJECT_MARKER_SECURE) #include <winapifamily.h>
#if !defined(SPP_PUBLISHING_INCLUDED_FROM_TRAMPOLINE) && !defined(SPP_PUBLISHING
_USE_FORCE_OFFICIAL) #pragma region Desktop Family
#error this header file cannot be included directly from SPP projects; use sppin #if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
c_* prefix instead.
#endif
#endif
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
#define SLFreeMemory(p) LocalFree(p) #define SLFreeMemory(p) LocalFree(p)
#define SLWGAFreeMemory(p) LocalFree(p) #define SLWGAFreeMemory(p) LocalFree(p)
typedef GUID SLID; typedef GUID SLID;
typedef PVOID HSLC;
typedef PVOID HSLP;
typedef enum _tagSLDATATYPE typedef enum _tagSLDATATYPE
{ {
SL_DATA_NONE = REG_NONE, SL_DATA_NONE = REG_NONE,
SL_DATA_SZ = REG_SZ, SL_DATA_SZ = REG_SZ,
SL_DATA_DWORD = REG_DWORD, SL_DATA_DWORD = REG_DWORD,
SL_DATA_BINARY = REG_BINARY, SL_DATA_BINARY = REG_BINARY,
SL_DATA_MULTI_SZ = REG_MULTI_SZ, SL_DATA_MULTI_SZ = REG_MULTI_SZ,
SL_DATA_SUM = 100, SL_DATA_SUM = 100,
} SLDATATYPE; } SLDATATYPE;
//
// Type of SL Id
//
typedef enum _tagSLIDTYPE
{
SL_ID_APPLICATION = 0,
SL_ID_PRODUCT_SKU,
SL_ID_LICENSE_FILE,
SL_ID_LICENSE,
SL_ID_PKEY,
SL_ID_ALL_LICENSES,
SL_ID_ALL_LICENSE_FILES,
SL_ID_STORE_TOKEN,
SL_ID_LAST
} SLIDTYPE;
//
// Licensing status
//
typedef enum _tagSLLICENSINGSTATUS
{
SL_LICENSING_STATUS_UNLICENSED,
SL_LICENSING_STATUS_LICENSED,
SL_LICENSING_STATUS_IN_GRACE_PERIOD,
SL_LICENSING_STATUS_NOTIFICATION,
SL_LICENSING_STATUS_LAST
} SLLICENSINGSTATUS;
//
// Licensing status
//
typedef struct _tagSL_LICENSING_STATUS
{
SLID SkuId; // SKU id
SLLICENSINGSTATUS eStatus; // licensing status, see SLLICENSINGSTA
TUS
DWORD dwGraceTime; // grace time in minute
DWORD dwTotalGraceDays; // pre-defined grace days in license
HRESULT hrReason; // the error of unlicensed status
UINT64 qwValidityExpiration; // Validity expiration day
} SL_LICENSING_STATUS;
//
// Product activation structures
//
typedef enum _tagSL_ACTIVATION_TYPE
{
SL_ACTIVATION_TYPE_DEFAULT = 0,
SL_ACTIVATION_TYPE_ACTIVE_DIRECTORY = 1,
} SL_ACTIVATION_TYPE;
typedef struct _tagSL_ACTIVATION_INFO_HEADER
{
DWORD cbSize;
SL_ACTIVATION_TYPE type;
} SL_ACTIVATION_INFO_HEADER;
//
// Active directory activation (header.type == SL_ACTIVATION_TYPE_ACTIVE_DIRECTO
RY)
//
typedef struct _tagSL_AD_ACTIVATION_INFO
{
SL_ACTIVATION_INFO_HEADER header;
PCWSTR pwszProductKey;
PCWSTR pwszActivationObjectName;
} SL_AD_ACTIVATION_INFO;
//
// Types of information that can be queried with SLGetReferralInformation
//
typedef enum
{
SL_REFERRALTYPE_SKUID = 0,
SL_REFERRALTYPE_APPID,
SL_REFERRALTYPE_OVERRIDE_SKUID,
SL_REFERRALTYPE_OVERRIDE_APPID,
SL_REFERRALTYPE_BEST_MATCH,
} SLREFERRALTYPE;
//
// Key words used to query information
//
#define SL_INFO_KEY_CHANNEL L"Channel"
#define SL_INFO_KEY_NAME L"Name"
#define SL_INFO_KEY_AUTHOR L"Author"
#define SL_INFO_KEY_DESCRIPTION L"Description"
#define SL_INFO_KEY_LICENSOR_URL L"LicensorUrl"
#define SL_INFO_KEY_DIGITAL_PID L"DigitalPID"
#define SL_INFO_KEY_DIGITAL_PID2 L"DigitalPID2"
#define SL_INFO_KEY_PARTIAL_PRODUCT_KEY L"PartialProductKey"
#define SL_INFO_KEY_PRODUCT_SKU_ID L"ProductSkuId"
#define SL_INFO_KEY_LICENSE_TYPE L"LicenseType"
#define SL_INFO_KEY_VERSION L"Version"
#define SL_INFO_KEY_SYSTEM_STATE L"SystemState"
#define SL_INFO_KEY_ACTIVE_PLUGINS L"ActivePlugins"
#define SL_INFO_KEY_SECURE_STORE_ID L"SecureStoreId"
#define SL_INFO_KEY_BIOS_PKEY L"BiosProductKey"
#define SL_INFO_KEY_BIOS_SLIC_STATE L"BiosSlicState"
#define SL_INFO_KEY_BIOS_OA2_MINOR_VERSION L"BiosOA2MinorVersio
n"
#define SL_INFO_KEY_SECURE_PROCESSOR_ACTIVATION_URL L"SPCURL"
#define SL_INFO_KEY_RIGHT_ACCOUNT_ACTIVATION_URL L"RACURL"
#define SL_INFO_KEY_PRODUCT_KEY_ACTIVATION_URL L"PKCURL"
#define SL_INFO_KEY_USE_LICENSE_ACTIVATION_URL L"EULURL"
#define SL_INFO_KEY_IS_KMS L"IsKeyManagementSer
vice"
#define SL_INFO_KEY_KMS_CURRENT_COUNT L"KeyManagementServi
ceCurrentCount"
#define SL_INFO_KEY_KMS_REQUIRED_CLIENT_COUNT L"KeyManagementServi
ceRequiredClientCount"
#define SL_INFO_KEY_KMS_UNLICENSED_REQUESTS L"KeyManagementServi
ceUnlicensedRequests"
#define SL_INFO_KEY_KMS_LICENSED_REQUESTS L"KeyManagementServi
ceLicensedRequests"
#define SL_INFO_KEY_KMS_OOB_GRACE_REQUESTS L"KeyManagementServi
ceOOBGraceRequests"
#define SL_INFO_KEY_KMS_OOT_GRACE_REQUESTS L"KeyManagementServi
ceOOTGraceRequests"
#define SL_INFO_KEY_KMS_NON_GENUINE_GRACE_REQUESTS L"KeyManagementServi
ceNonGenuineGraceRequests"
#define SL_INFO_KEY_KMS_NOTIFICATION_REQUESTS L"KeyManagementServi
ceNotificationRequests"
#define SL_INFO_KEY_KMS_TOTAL_REQUESTS L"KeyManagementServi
ceTotalRequests"
#define SL_INFO_KEY_KMS_FAILED_REQUESTS L"KeyManagementServi
ceFailedRequests"
#define SL_INFO_KEY_IS_PRS L"IsPRS"
//
// PKey Algorithms
//
#define SL_PKEY_MS2005 L"msft:rm/algorithm/
pkey/2005"
#define SL_PKEY_MS2009 L"msft:rm/algorithm/
pkey/2009"
#define SL_PKEY_DETECT L"msft:rm/algorithm/
pkey/detect"
//
// SL Event
//
#define SL_EVENT_LICENSING_STATE_CHANGED L"msft:rm/event/lice
nsingstatechanged"
#define SL_EVENT_POLICY_CHANGED L"msft:rm/event/poli
cychanged"
#define SL_EVENT_USER_NOTIFICATION L"msft:rm/event/user
notification"
//
// SL System State Mask
//
#define SL_SYSTEM_STATE_REBOOT_POLICY_FOUND 0x00000001 // r
eboot required
#define SL_SYSTEM_STATE_TAMPERED 0x00000002 // t
amper (generic)
//
// SL Rearm Flags
//
#define SL_REARM_REBOOT_REQUIRED 0x00000001 // r
equire a reboot after performing rearm
//
// SPP Migration State Mask
//
#define SPP_MIGRATION_GATHER_MIGRATABLE_APPS 0x00000001
#define SPP_MIGRATION_GATHER_ACTIVATED_WINDOWS_STATE 0x00000002
#define SPP_MIGRATION_GATHER_ALL 0xFFFFFFFF
typedef enum _SL_GENUINE_STATE typedef enum _SL_GENUINE_STATE
{ {
SL_GEN_STATE_IS_GENUINE = 0, SL_GEN_STATE_IS_GENUINE = 0,
SL_GEN_STATE_INVALID_LICENSE, SL_GEN_STATE_INVALID_LICENSE,
SL_GEN_STATE_TAMPERED, SL_GEN_STATE_TAMPERED,
SL_GEN_STATE_LAST, SL_GEN_STATE_LAST,
} SL_GENUINE_STATE; } SL_GENUINE_STATE;
typedef struct _tagSL_NONGENUINE_UI_OPTIONS typedef struct _tagSL_NONGENUINE_UI_OPTIONS
{ {
DWORD cbSize; DWORD cbSize;
CONST SLID* pComponentId; CONST SLID* pComponentId;
HRESULT hResultUI; HRESULT hResultUI;
} SL_NONGENUINE_UI_OPTIONS; } SL_NONGENUINE_UI_OPTIONS;
#define SL_PROP_BRT_DATA L"SL_BRT_DATA" #define SL_PROP_BRT_DATA L"SL_BRT_DATA"
#define SL_PROP_BRT_COMMIT L"SL_BRT_COMMIT" #define SL_PROP_BRT_COMMIT L"SL_BRT_COMMIT"
#define SL_PROP_GENUINE_RESULT L"SL_GENUINE_RESULT" #define SL_PROP_GENUINE_RESULT L"SL_GENUINE_RESULT"
#define SL_PROP_NONGENUINE_GRACE_FLAG L"SL_NONGENUINE_GRAC E_FLAG" #define SL_PROP_NONGENUINE_GRACE_FLAG L"SL_NONGENUINE_GRAC E_FLAG"
#define SL_PROP_GET_GENUINE_AUTHZ L"SL_GET_GENUINE_AUT
HZ"
#define SL_PROP_LAST_ACT_ATTEMPT_HRESULT L"SL_LAST_ACT_ATTEMP
T_HRESULT"
#define SL_PROP_LAST_ACT_ATTEMPT_TIME L"SL_LAST_ACT_ATTEMP
T_TIME"
#define SL_PROP_LAST_ACT_ATTEMPT_SERVER_FLAGS L"SL_LAST_ACT_ATTEMP
T_SERVER_FLAGS"
#define SL_PROP_ACTIVATION_VALIDATION_IN_PROGRESS L"SL_ACTIVATION_VALI
DATION_IN_PROGRESS"
#define SL_POLICY_EVALUATION_MODE_ENABLED L"Security-SPP-Evalu ationModeEnabled" #define SL_POLICY_EVALUATION_MODE_ENABLED L"Security-SPP-Evalu ationModeEnabled"
#define SL_DEFAULT_MIGRATION_ENCRYPTOR_URI L"msft:spp/migration
encryptor/tokenact/1.0"
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLOpen(
_Out_ HSLC* phSLC
);
/*++
Routine Description:
Initializes the Software Licensing Client (SLC)
and connect SLC to Software Licensing Service (SLS).
If succeeds, a context handle is returned for subsequent calls.
Arguments:
phSLC
Pointer to context handle returned from service.
Return Error:
E_INVALIDARG
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLClose(
_In_ HSLC hSLC
);
/*++
Routine Description:
Close SLC context handle. When this function is called,
the associated context on SL service is released.
Arguments:
hSLC
Handle to current SLC context.
Return Error:
E_INVALIDARG
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLInstallProofOfPurchase(
_In_ HSLC hSLC,
_In_ PCWSTR pwszPKeyAlgorithm,
_In_ PCWSTR pwszPKeyString,
_In_ UINT cbPKeySpecificData,
_In_reads_bytes_opt_(cbPKeySpecificData) PBYTE pbPKeySpecificData,
_Out_ SLID* pPkeyId
);
/*+
Routine Description:
Register the product key with SL.
Arguments:
hSLC
Handle to current SLC context.
pwszPKeyAlgorithm
Product Key algorithm.
pwszPKeyString
Product key string (e.g. 5x5 string).
cbPKeySpecificData
Size of product key specific data. If no PKey specific data, set to 0.
pbPKeySpecificData
Product key specific data. If no PKey specific data, set to NULL.
pPkeyId
An Identifier of the registered Product key, so caller
can reference PKey information later.
Return Error:
E_INVALIDARG
E_ACCESSDENIED
SL_E_LUA_ACCESSDENIED
SL_E_INVALID_PKEY
SL_E_PRODUCT_SKU_NOT_INSTALLED
SL_E_UNSUPPORTED
SL_E_PKEY_INVALID_UPGRADE
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLInstallProofOfPurchaseEx(
_In_ HSLC hSLC,
_In_ CONST SLID* pApplicationId,
_In_opt_ CONST SLID* pProductSkuId,
_In_ PCWSTR pwszPKeyAlgorithm,
_In_ PCWSTR pwszPKeyString,
_In_ UINT cbPKeySpecificData,
_In_reads_bytes_opt_(cbPKeySpecificData) PBYTE pbPKeySpecificData,
_Out_ SLID* pPkeyId
);
/*+
Routine Description:
Register the product key with SL.
Arguments:
hSLC
Handle to current SLC context.
pApplicationId
Application Id
pProductSkuId
Product Sku Id
pwszPKeyAlgorithm
Product Key algorithm.
pwszPKeyString
Product key string (e.g. 5x5 string).
cbPKeySpecificData
Size of product key specific data. If no PKey specific data, set to 0.
pbPKeySpecificData
Product key specific data. If no PKey specific data, set to NULL.
pPkeyId
An Identifier of the registered Product key, so caller
can reference PKey information later.
Return Error:
E_INVALIDARG
E_ACCESSDENIED
SL_E_LUA_ACCESSDENIED
SL_E_INVALID_PKEY
SL_E_PRODUCT_SKU_NOT_INSTALLED
SL_E_UNSUPPORTED
SL_E_PKEY_INVALID_UPGRADE
SL_E_MISMATCHED_PRODUCT_SKU
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLUninstallProofOfPurchase(
_In_ HSLC hSLC,
_In_ CONST SLID* pPKeyId
);
/*++
Routine Description:
Unregister the product key information.
Arguments:
hSLC
Handle to current SLC context.
pPkeyId
Identifier of the registered Product key.
Return Error:
E_INVALIDARG
E_ACCESSDENIED
SL_E_LUA_ACCESSDENIED
SL_E_PKEY_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLInstallLicense(
_In_ HSLC hSLC,
_In_ UINT cbLicenseBlob,
_In_reads_bytes_(cbLicenseBlob) CONST BYTE* pbLicenseBlob,
_Out_ SLID* pLicenseFileId
);
/*++
Routine Description:
Callers pass in license blob (in bytes) and size of blob.
SL stores the license and returned a license file Id.
Arguments:
hSLC
Handle to current SLC context.
cbLicenseBlob
Size of license blob
pbLicenseBlob
licenses in blob. The caller can open/read license file or
receives the blob from
pLicenseFileId
License File Id
Return Error:
E_INVALIDARG
E_ACCESSDENIED
SL_E_LUA_ACCESSDENIED
SL_E_INVALID_LICENSE
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLUninstallLicense(
_In_ HSLC hSLC,
_In_ CONST SLID* pLicenseFileId
);
/*++
Routine Description:
Uninstall a license file according to license file Id and target
user option.
Arguments:
hSLC
Handle to current SLC context.
pLicenseFileId
License file Id.
Return Error:
E_INVALIDARG
E_ACCESSDENIED
SL_E_LUA_ACCESSDENIED
SL_E_LICENSE_FILE_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLConsumeRight(
_In_ HSLC hSLC,
_In_ CONST SLID* pAppId,
_In_opt_ CONST SLID* pProductSkuId,
_In_opt_ PCWSTR pwszRightName,
_Reserved_ PVOID pvReserved
);
/*++
Routine Description:
Let an application to exercise rights on a locally-stored licenses.
Calling this function binds a license to the right. If this right
cannot be exercised, then the application gets failed result.
Arguments:
hSLC
Handle to current SLC context.
pAppId
The identifier of the application who's right is going to be
consumed.
pProductSkuId
The identifier of Product SKU. If NULL, all Product SKU's
licenses will be consumed.
pwszRightName
The name of right to be consumed.
pvReserved
Reserved.
Return Error:
E_INVALIDARG
SL_E_RIGHT_NOT_GRANTED
SL_E_PRODUCT_SKU_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetProductSkuInformation(
_In_ HSLC hSLC,
_In_ CONST SLID* pProductSkuId,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
Get information about specified product Sku.
Arguments:
hSLC
Handle to current SLC context.
pwszValueName
SL_INFO_KEY_NAME
Return Type = SL_DATA_SZ
Return Data = The product name
SL_INFO_KEY_DESCRIPTION
Return Type = SL_DATA_SZ
Return Data = Description of the product
SL_INFO_KEY_AUTHOR
Return Type = SL_DATA_SZ
Return Data = Author of the product
The caller can also query the value specified in public OOB
otherInfo. (use same key name defined there)
peDataType
Data type. Following types are supported:
SL_DATA_SZ - UNICODE string
SL_DATA_DWORD - DWORD
SL_DATA_BINARY - Binary blob
pcbValue
Size of the allocated buffer.
ppbValue
If successful, the data is returned in the buffer allocated by SLC.
The caller has to call LocalFree to free the memory.
Return Error:
E_INVALIDARG
SL_E_VALUE_NOT_FOUND
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetPKeyInformation(
_In_ HSLC hSLC,
_In_ CONST SLID* pPKeyId,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
Get information of specified product key
Arguments:
hSLC
Handle to current SLC context.
pwszValueName
SL_INFO_KEY_DIGITAL_PID
Return Type = SL_DATA_SZ
Return Data = Formatted PID structure for a PID4
SL_INFO_KEY_DIGITAL_PID2
Return Type = SL_DATA_SZ
Return Data = Formatted PID structure for a PID2
SL_INFO_KEY_PARTIAL_PRODUCT_KEY
Return Type = SL_DATA_SZ
Return Data = First 5 characters of Product Key
SL_INFO_KEY_PRODUCT_SKU_ID
Return Type = SL_DATA_BINARY (SLID)
Return Data = Sku SLID
SL_INFO_KEY_CHANNEL
Return Type SL_DATA_SZ
Return Data = Channel Id
peDataType
Data type. Following types are supported:
SL_DATA_SZ - UNICODE string
SL_DATA_DWORD - DWORD
SL_DATA_BINARY - Binary blob
pcbValue
Size of the allocated buffer.
ppbValue
If successful, the data is returned in the buffer allocated by SLC.
The caller has to call LocalFree to free the memory.
Return Error:
E_INVALIDARG
SL_E_PKEY_NOT_INSTALLED
SL_E_NOT_SUPPORTED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetLicenseInformation(
_In_ HSLC hSLC,
_In_ CONST SLID* pSLLicenseId,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
Get information of specified license
Arguments:
hSLC
Handle to current SLC context.
pwszValueName
SL_INFO_KEY_DESCRIPTION
Return Type = SL_DATA_SZ
Return Data = Description of the license
SL_INFO_KEY_LICENSE_TYPE
Return Type = SL_DATA_SZ
Return Data = The type of the license
SL_INFO_KEY_VERSION
Return Type = SL_DATA_SZ
Return Data = The version of the license
The caller can also query the value specified in license's
otherInfo. (use same key name defined there)
peDataType
Data type. Following types are supported:
SL_DATA_SZ - UNICODE string
SL_DATA_DWORD - DWORD
SL_DATA_BINARY - Binary blob
pcbValue
Size of the allocated buffer.
ppbValue
If successful, the data is returned in the buffer allocated by SLC.
The caller has to call LocalFree to free the memory.
Return Error:
E_INVALIDARG
SL_E_VALUE_NOT_FOUND
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetLicensingStatusInformation(
_In_ HSLC hSLC,
_In_opt_ CONST SLID* pAppID,
_In_opt_ CONST SLID* pProductSkuId,
_In_opt_ PCWSTR pwszRightName,
_Out_ UINT* pnStatusCount,
_Outptr_result_buffer_(*pnStatusCount) SL_LICENSING_STATUS** ppLicensingStat
us
);
/*++
Routine Description:
Get information of licensing status of specified application/Sku
Arguments:
hSLC
Handle to current SLC context.
pAppID, pProductSkuId
Optional.
pAppID=NULL, pProductSkuId=NULL
Get previous right consumption result.
pAppID=NULL, pProductSkuId=not NULL
Get licensing status of this Sku
pAppID=not NULL, pProductSkuId=NULL
Get licensing status of this Application
pAppID=not NULL, pProductSkuId=not NULL
Get licensing status of this Application/Sku
pwszRightName
NULL
pnStatusCount
Number of Sku's status
ppLicensingStatus
Sku's status
Return Error:
E_INVALIDARG
SL_E_RIGHT_NOT_CONSUMED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetPolicyInformation(
_In_ HSLC hSLC,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
Get information of poliy after right has been consumed successfully
Arguments:
hSLC
Handle to current SLC context.
pwszValueName
The name of the policy name
peDataType
Data type. Following types are supported:
SL_DATA_SZ - UNICODE string
SL_DATA_DWORD - DWORD
SL_DATA_BINARY - Binary blob
pcbValue
Size of the allocated buffer.
ppbValue
If successful, the data is returned in the buffer allocated by SLC.
The caller has to call LocalFree to free the memory.
Return Error:
E_INVALIDARG
SL_E_VALUE_NOT_FOUND
SL_E_RIGHT_NOT_GRANTED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetPolicyInformationDWORD(
_In_ HSLC hSLC,
_In_ PCWSTR pwszValueName,
_Out_ DWORD* pdwValue
);
/*++
Routine Description:
Sililar to SLGetPolicyInformation.
Callers pass in a dword buffer.
Arguments:
hSLC
Handle to current SLC context.
pwszValueName
The name of the policy name
pdwValue
Return value
Return Error:
E_INVALIDARG
SL_E_VALUE_NOT_FOUND
SL_E_RIGHT_NOT_GRANTED
SL_E_DATATYPE_MISMATCHED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetServiceInformation(
_In_ HSLC hSLC,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
Get information of global data, like service version,
tamper status ... etc.
Arguments:
hSLC
Handle to current SLC context.
pwszValueName
The name of the key for query.
SL_INFO_KEY_VERSION
version of SL service. e.g. "1.2.3.4"
Return Type = SL_DATA_SZ
SL_INFO_KEY_SYSTEM_STATE
System state
SL_SYSTEM_STATE_TAMPERED
SL_SYSTEM_STATE_REBOOT_POLICY_FOUND
Return Type = SL_DATA_DWORD
SL_INFO_KEY_ACTIVE_PLUGINS
Return Type = SL_DATA_MULTI_SZ
Return Data = Fully-qualified DLL paths for all active plugins
(NULL-delimited and double-NULL terminated)
SL_INFO_KEY_SECURE_STORE_ID
Return Type = SL_DATA_SZ
Return Data = Secure store ID (GUID)
SL_INFO_KEY_SESSION_MACHINE_ID
Return Type = SL_DATA_BINARY
Return Data = Session machine ID (Binary Blob)
peDataType
Data type. Following types are supported:
SL_DATA_SZ - UNICODE string
SL_DATA_DWORD - DWORD
SL_DATA_BINARY - Binary blob
SL_DATA_MULTI_SZ - Double-NULL terminated UNICODE string array
pcbValue
Size of the allocated buffer.
ppbValue
If successful, the data is returned in the buffer allocated by SLC.
The caller has to call LocalFree to free the memory.
Return Error:
E_INVALIDARG
SL_E_VALUE_NOT_FOUND
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetApplicationInformation(
_In_ HSLC hSLC,
_In_ const SLID* pApplicationId,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
Get information about specified application.
Arguments:
hSLC
Handle to current SLC context.
pwszValueName
SL_INFO_KEY_IS_KMS
Return Type = SL_DATA_DWORD
Return Data = Indicates whether the machine has a key management ser
vice enabled
SL_INFO_KEY_KMS_CURRENT_COUNT
Return Type = SL_DATA_DWORD
Return Data = Count of currently active volume clients on KMS host
SL_INFO_KEY_KMS_REQUIRED_CLIENT_COUNT
Return Type = SL_DATA_DWORD
Return Data = Min number of VL clients required to connect to a KMS
host for enabling activation
SL_INFO_KEY_KMS_UNLICENSED_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Count of KMS requests from VL clients with License Sta
tus=Unlicensed
SL_INFO_KEY_KMS_LICENSED_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Count of KMS requests from VL clients with License Sta
tus=Licensed
SL_INFO_KEY_KMS_OOB_GRACE_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Count of KMS requests from VL clients with License Sta
tus=OOB Grace
SL_INFO_KEY_KMS_OOT_GRACE_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Count of KMS requests from VL clients with License Sta
tus=OOT Grace
SL_INFO_KEY_KMS_NON_GENUINE_GRACE_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Count of KMS requests from VL clients with License Sta
tus=Non-Genuine Grace
SL_INFO_KEY_KMS_NOTIFICATION_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Count of KMS requests from VL clients with License Sta
tus=Notification
SL_INFO_KEY_KMS_TOTAL_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Total count of valid KMS requests
SL_INFO_KEY_KMS_FAILED_REQUESTS
Return Type = SL_DATA_DWORD
Return Data = Total count of failed KMS requests
peDataType
Data type. Following types are supported:
SL_DATA_SZ - UNICODE string
SL_DATA_DWORD - DWORD
SL_DATA_BINARY - Binary blob
pcbValue
Size of the allocated buffer.
ppbValue
If successful, the data is returned in the buffer allocated by SLC.
The caller has to call LocalFree to free the memory.
Return Error:
E_INVALIDARG
SL_E_VALUE_NOT_FOUND
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLActivateProduct(
_In_ HSLC hSLC,
_In_ CONST SLID* pProductSkuId,
_In_opt_ UINT cbAppSpecificData,
_In_opt_ CONST PVOID pvAppSpecificData,
_In_opt_ CONST SL_ACTIVATION_INFO_HEADER* pActivationInfo
,
_In_opt_ PCWSTR pwszProxyServer,
_In_opt_ WORD wProxyPort
);
/*++
Routine Description:
Acquire use licenses (q.g. retail-online or Volume ... etc,).
Arguments:
hSLC
Handle to current SLC context.
pProductSkuId
Porduct Id.
cbAppSpecificData
Size of application specific data.
pbAppSpecificData
Application specific data. License server can use this
information to embed application specific run-time information.
pActivationInfo
Additional information; depends on the type of activation (see remark).
pwszProxyServer
Proxy server name (optional). NULL for automatic proxy discovery
wProxyPort
Proxy server port. 0 for default port.
Remark:
This function can be used for Retail and Active Directory phone activation.
Depending on the activation type, the pActivationInfo should be filled
as follows:
Retail activation:
pActivationInfo must be set to NULL.
Active Directory activation:
SL_AD_ACTIVATION_INFO AdaOnlineInfo;
memset(&AdaOnlineInfo, 0, sizeof(AdaOnlineInfo);
AdaOnlineInfo->header.cbSize = sizeof(AdaOnlineInfo);
AdaOnlineInfo->header.type = SL_ACTIVATION_TYPE_ACTIVE_DIRECTORY;
AdaOnlineInfo->pwszProductKey = L"<5x5 Product Key>";
AdaOnlineInfo->pwszActivationObjectName = L"<string>"; // or NULL
The product key will not be installed.
Return Error:
E_INVALIDARG
SL_E_PUBLISHING_LICENSE_NOT_INSTALLED
SL_E_PKEY_NOT_INSTALLED
SL_E_PRODUCT_SKU_NOT_INSTALLED
SL_E_ACTIVATION_IN_PROGRESS
Network errors
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetServerStatus(
_In_ PCWSTR pwszServerURL,
_In_ PCWSTR pwszAcquisitionType,
_In_opt_ PCWSTR pwszProxyServer,
_In_opt_ WORD wProxyPort,
_Out_ HRESULT* phrStatus
);
/*++
Routine Description:
This function checks the server status according to the specified
URL and RequestType.
Callers can either pass in URL kept by themselves or get SKU
specific URL by calling GetProductSkuInformation and query each
URL.
Arguments:
pwszServerURL
Server's URL .
pwszAcquisitionType
see slapi.h. There are 5 acquisition types.
SL_INFO_KEY_SECURE_PROCESSOR_ACTIVATION_URL
SL_INFO_KEY_RIGHT_ACCOUNT_ACTIVATION_URL
SL_INFO_KEY_PRODUCT_KEY_ACTIVATION_URL
SL_INFO_KEY_USE_LICENSE_ACTIVATION_URL
SL_INFO_KEY_PRODUCT_ACTIVATION_URL
pwszProxyServer
Proxy server name (optional). NULL for automatic proxy discovery
wProxyPort
Proxy server port. 0 for default port.
phrStatus
Server status.
S_OK
Network errors
Return Error:
E_INVALIDARG
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetActiveLicenseInfo(
_In_ HSLC hSLC,
_Reserved_ CONST SLID* pReserved,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
This function returns active license data so the caller can decide on applic
ability.
Arguments: none
hSLC
Handle to current SLC session.
pReserved
Reserved for future use. Must be NULL.
pcbValue,
receives the total length in bytes of the data returned.
ppbValue
receives the allocated byte buffer that contains the active license info
.
The caller should call LocalFree to free the buffer.
Return Error:
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLDepositStoreToken(
_In_ HSLC hSLC,
_In_ UINT cbValue,
_In_reads_bytes_(cbValue) CONST BYTE* pbValue
);
/*++
Routine Description:
This function returns active license data so the caller can decide on applic
ability.
Arguments: none
hSLC
Handle to current SLC session.
cbValue,
length of the input byte stream
pbValue
byte stream of XML DSig data
Return Error:
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLReArm(
_In_ HSLC hSLC,
_In_ CONST SLID* pApplicationId,
_In_opt_ CONST SLID* pProductSkuId,
_In_ DWORD dwFlags
);
/*++
Routine Description:
This function is rearm application activation.
Arguments: none
hSLC
Handle to current SLC session.
pApplicationId,
Applicaiton Id.
pProductSkuId
Product SKU Id.
dwFlags
Flags for ReArm behavior. Valid values are 0 or
SL_REARM_REBOOT_REQUIRED. Passing SL_REARM_REBOOT_REQUIRED will
require a reboot before an API using the security processor can
succeed.
Return Error:
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGenerateOfflineInstallationId(
_In_ HSLC hSLC,
_In_ CONST SLID* pProductSkuId,
_Outptr_ PWSTR* ppwszInstallationId
);
/*++
Routine Description:
Generate Installation Id (IID).
Users can send the IID to CSR to get the Confirmation Id (CID).
Arguments:
hSLC
Handle to current SLC context.
pProductSkuId
Product Id.
ppwszInstallationId
The Installation Id string. The caller calls LocalFree to
free memory.
Return Error:
E_INVALIDARG
SL_E_PKEY_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGenerateOfflineInstallationIdEx(
_In_ HSLC hSLC,
_In_opt_ CONST SLID* pProductSkuId,
_In_opt_ CONST SL_ACTIVATION_INFO_HEADER* pActivationInfo
,
_Outptr_ PWSTR* ppwszInstallationId
);
/*++
Routine Description:
Generate Installation Id (IID).
Users can send the IID to CSR to get the Confirmation Id (CID).
Arguments:
hSLC
Handle to current SLC context.
pProductSkuId
Product Id.
pActivationInfo
Additional information; depends on the type of activation (see remark).
ppwszInstallationId
The Installation Id string. The caller calls LocalFree to
free memory.
Remark:
This function can be used for Retail and Active Directory phone activation.
Depending on the activation type, the pActivationInfo should be filled
as follows:
Retail activation:
pActivationInfo must be set to NULL. In this case the function
works the same way as SLDepositOfflineConfirmationId.
Active Directory activation:
SL_AD_ACTIVATION_INFO AdaRequestInfo;
memset(&AdaRequestInfo, 0, sizeof(AdaRequestInfo);
AdaRequestInfo->header.cbSize = sizeof(AdaRequestInfo);
AdaRequestInfo->header.type = SL_ACTIVATION_TYPE_ACTIVE_DIR
ECTORY;
AdaRequestInfo->pwszProductKey = L"<5x5 Product Key>";
AdaRequestInfo->pwszActivationObjectName = NULL;
The product key will not be installed.
Return Error:
E_INVALIDARG
SL_E_PKEY_NOT_INSTALLED
TODO: (ADA) more error codes here.
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLDepositOfflineConfirmationId(
_In_ HSLC hSLC,
_In_ CONST SLID* pProductSkuId,
_In_ PCWSTR pwszInstallationId,
_In_ PCWSTR pwszConfirmationId
);
/*++
Routine Description:
Deposit Installation Id (IID) and Confirmation Id (CID) for off-line activat
ion.
Arguments:
hSLC
Handle to current SLC context.
pProductSkuId
Product Id.
pwszInstallationId
The Installation Id generated by SLGenerateOfflineInstallationId(Ex).
pwszConfirmationId
The confirmation Id CSR generated for users.
Return Error:
E_INVALIDARG
SL_E_CIDIID_INVALID_CHECK_DIGITS
SL_E_PRODUCT_SKU_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLDepositOfflineConfirmationIdEx(
_In_ HSLC hSLC,
_In_opt_ CONST SLID* pProductSkuId,
_In_opt_ CONST SL_ACTIVATION_INFO_HEADER* pActivationInfo
,
_In_ PCWSTR pwszInstallationId,
_In_ PCWSTR pwszConfirmationId
);
/*++
Routine Description:
Deposit Installation Id (IID) and Confirmation Id (CID) for off-line activat
ion.
Arguments:
hSLC
Handle to current SLC context.
pProductSkuId
Product Id.
pActivationInfo
Additional information; depends on the type of activation (see remark).
pwszInstallationId
The Installation Id generated by SLGenerateOfflineInstallationId(Ex).
pwszConfirmationId
The confirmation Id CSR generated for users.
Remark:
This function can be used for Retail and Active Directory phone activation.
Depending on the activation type, the pActivationInfo should be filled
as follows:
Retail activation:
pActivationInfo must be set to NULL. In this case the function
works the same way as SLDepositOfflineConfirmationId.
Active Directory activation:
SL_AD_ACTIVATION_INFO AdaDepositInfo;
memset(&AdaDepositInfo, 0, sizeof(AdaDepositInfo);
AdaDepositInfo->header.cbSize = sizeof(AdaDepositInfo);
AdaDepositInfo->header.type = SL_ACTIVATION_TYPE_ACTIVE_DIR
ECTORY;
AdaDepositInfo->pwszProductKey = L"<5x5 Product Key>";
AdaDepositInfo->pwszActivationObjectName = L"<string>"; // or NULL
The product key must be the one used to generate pwszInstallationId.
Return Error:
E_INVALIDARG
SL_E_CIDIID_INVALID_CHECK_DIGITS
SL_E_PRODUCT_SKU_NOT_INSTALLED
TODO: (ADA) more error codes here.
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetPKeyId(
_In_ HSLC hSLC,
_In_ PCWSTR pwszPKeyAlgorithm,
_In_ PCWSTR pwszPKeyString,
_In_ UINT cbPKeySpecificData,
_In_reads_bytes_opt_(cbPKeySpecificData) CONST BYTE* pbPKeySpecificData,
_Out_ SLID* pPKeyId
);
/*++
Routine Description:
Get the registered Product Key Id associated with the Product.
Arguments:
hSLC
Handle to current SLC context.
pwszPKeyAlgorithm
Product Key algorithm.
pwszPKeyString
Product key string (e.g. 5x5 string).
cbPKeySpecificData
Size of product key specific data. If no PKey specific data, set to 0.
pbPKeySpecificData
Product key specific data. If no PKey specific data, set to NULL.
pPKeyId
The Product Key Id associated with the Product.
Return Error:
E_INVALIDARG
SL_E_PKEY_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetInstalledProductKeyIds(
_In_ HSLC hSLC,
_In_ CONST SLID* pProductSkuId,
_Out_ UINT* pnProductKeyIds,
_Outptr_result_buffer_(*pnProductKeyIds) SLID** ppProductKeyIds
);
/*++
Routine Description:
This function returns a list of product key Ids associated
with the specified Product SKU Id.
Arguments:
hSLC
Handle to current SLC session.
pProductSkuId
Product SKU Id.
pnProductKeyIds
Number of Product Key Ids returned.
hEvent
Returned Product Key Ids.
Return Error:
SL_E_VALUE_NOT_FOUND
--*/
__control_entrypoint(DllExport) __control_entrypoint(DllExport)
HRESULT HRESULT
WINAPI WINAPI
SLSetCurrentProductKey(
_In_ HSLC hSLC,
_In_ CONST SLID* pProductSkuId,
_In_ CONST SLID* pProductKeyId
);
/*++
Routine Description:
This function let the caller set current
product key to previously installed product key.
Arguments:
hSLC
Handle to current SLC session.
pProductSkuId
Product SKU Id.
pProductKeyId
Product Key Id.
Return Error:
SL_E_MISMATCHED_PRODUCT_SKU
SL_E_PKEY_NOT_INSTALLED
SL_E_OPERATION_NOT_ALLOWED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetSLIDList(
_In_ HSLC hSLC,
_In_ SLIDTYPE eQueryIdType,
_In_opt_ CONST SLID* pQueryId,
_In_ SLIDTYPE eReturnIdType,
_Out_ UINT* pnReturnIds,
_Outptr_result_buffer_(*pnReturnIds) SLID** ppReturnIds
);
/*++
Description:
Get a list of SLIDs according to input query Id type and Id value.
For example, input Id is SkuId, and return Id is AppId, which means
the caller wants to get a list of AppId associated with this SkuId.
If no information is found, then *pnReturnIds is 0.
Parameters:
eQueryIdType
The type of input Id
rQueryId
The input Id
eReturnIdType
The type of returned Ids.
pnReturnIds
Number of returned Ids.
ppReturnIds
Returned Ids.
Remark:
Support following queries.
SL_ID_APPLICATION, SLID_ALL, SL_ID_APPLICATION
Get All Installed Application Ids.
SL_ID_PRODUCT_SKU, SLID_ALL, SL_ID_PRODUCT_SKU
Get All Installed Product Sku Ids.
SL_ID_APPLICATION, appId , SL_ID_PRODUCT_SKU
Get Sku Ids according to the input App Id.
SL_ID_PRODUCT_SKU, skuId , SL_ID_APPLICATION
Get App Ids according to the input Sku Id
SL_ID_PRODUCT_SKU, skuId , SL_ID_PKEY
Get License PKey Ids according to the input Sku Id
SL_ID_PRODUCT_SKU, skuId , SL_ID_LICENSE_FILE
Get License file Ids according to the input Sku Id
SL_ID_LICENSE_FILE, fileId , SL_ID_LICENSE
Get License Ids according to the input License File Id
SL_ID_LICENSE, LicenseId, SL_ID_LICENSE_FILE
Get License File Id according to the input License Id
SL_ID_LICENSE, LicenseId, SL_ID_APPLICATION
SL_ID_LICENSE, LicenseId, SL_ID_PRODUCT_SKU
Get union of all App Ids or Sku Ids from all grants of
a token activation license. Returns SL_E_NOT_SUPPORTED
if the LicenseId is valid but doesn't refer to a token
activation license.
SL_ID_PKEY, PkeyId, SL_ID_STORE_TOKEN
Get Store token Id according to the input product key id
SL_ID_STORE_TOKEN, SLID_ALL, SL_ID_STORE_TOKEN
Get all Store token Ids
If callers give the combinations not listed above, then the
API will return SL_E_NOT_SUPPORTED.
Return Error:
E_INVALIDARG
SL_E_VALUE_NOT_FOUND
SL_E_NOT_SUPPORT
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetLicenseFileId(
_In_ HSLC hSLC,
_In_ UINT cbLicenseBlob,
_In_reads_bytes_(cbLicenseBlob) CONST BYTE* pbLicenseBlob,
_Out_ SLID* pLicenseFileId
);
/*++
Routine Description:
This function takes the license blob and find if it has been
installed already. If not, return SL_E_FILE_NOT_INSTALLED, otherwisw,
return an LicenseFileId.
Arguments:
hSLC
Handle to current SLC context.
cbLicenseBlob
Size of license blob
pbLicenseBlob
licenses in blob. The caller can open/read license file or
receives the blob from
pLicenseFileId
License File Id
Return Error:
E_INVALIDARG
SL_E_INVALID_LICENSE
SL_E_LICENSE_FILE_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetLicense(
_In_ HSLC hSLC,
_In_ CONST SLID* pLicenseFileId,
_Out_ UINT* pcbLicenseFile,
_Outptr_result_bytebuffer_(*pcbLicenseFile) PBYTE* ppbLicenseFile
);
/*++
Routine Description:
This function returns the license file blob.
Arguments:
hSLC
Handle to current SLC context.
pLicenseFileId
License file Id
pcbLicenseFile
Size of license file blob
ppbLicenseFile
License file blob
Return Error:
E_INVALIDARG
SL_E_LICENSE_FILE_NOT_INSTALLED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLFireEvent(
_In_ HSLC hSLC,
_In_ PCWSTR pwszEventId,
_In_ CONST SLID* pApplicationId
);
/*++
Routine Description:
This function sends specified event to registered listener
(whoever registered the event with the spcified AppId).
The caller has to have administrator privilege to call this function.
Arguments:
hSLC
Handle to current SLC session.
pwszEventId
Event to be fired.
pApplicationId
Application Id.
Return Error:
E_ACCESSDENIED
SL_E_INVALID_EVENT_ID
SL_E_EVENT_NOT_REGISTERED
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLRegisterEvent(
_In_opt_ HSLC hSLC,
_In_ PCWSTR pwszEventId,
_In_ CONST SLID* pApplicationId,
_In_ HANDLE hEvent
);
/*++
Routine Description:
This function registers an event in SL service.
The caller can receive notifications when the registered event is fired.
Arguments:
hSLC
Handle to current SLC session (optional).
- hSLC == NULL, service is running:
SLOpen will be called internally before the RPC call.
- hSLC != NULL, service is running:
Use the provided handle to do the RPC call.
- Service is not running (hSLC is not used in that case):
Service won't be started, event will be correctly registered on serv
ice start.
pwszEventId
Predefined SL event identifier.
pApplicationId
Register the event to this Application Id.
hEvent
Caller provides the event handle used for notification.
Return Error:
SL_E_INVALID_EVENT_ID
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLUnregisterEvent(
_In_opt_ HSLC hSLC,
_In_ PCWSTR pwszEventId,
_In_ CONST SLID* pApplicationId,
_In_ HANDLE hEvent
);
/*++
Routine Description:
This function unregisters an registered event in SL service.
After unregisteration, SL stopps notifying this event.
Arguments:
hSLC
Handle to current SLC session (optional).
- hSLC == NULL, service is running:
SLOpen will be called internally before the RPC call.
- hSLC != NULL, service is running:
Use the provided handle to do the RPC call.
- Service is not running (hSLC is not used in that case):
Service won't be started, event will be correctly un-registered.
pwszEventId
Predefined SL event identifier.
pApplicationId
Unegister the event from this Application Id.
hEvent
The registered event handle.
Return Error:
SL_E_INVALID_EVENT_ID
SL_E_EVENT_NOT_REGISTERED
--*/
HRESULT
WINAPI
SLGetWindowsInformation( SLGetWindowsInformation(
__in PCWSTR pwszValueName, _In_ PCWSTR pwszValueName,
__out_opt SLDATATYPE* peDataType, _Out_opt_ SLDATATYPE* peDataType,
__out UINT* pcbValue, _Out_ UINT* pcbValue,
__deref_out_bcount(*pcbValue) PBYTE* ppbValue _Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
); );
/*++ /*++
Routine Description: Routine Description:
This function is used to for Windows components to get This function is used to for Windows components to get
component policy value. component policy value.
Arguments: Arguments:
pwszValueName pwszValueName
skipping to change at line 105 skipping to change at line 1770
Size of the allocated buffer. Size of the allocated buffer.
ppbValue ppbValue
The value. If successful, the data is returned in the buffer The value. If successful, the data is returned in the buffer
allocated by SLC. allocated by SLC.
The caller has to call SLFreeMemory to free the memory. The caller has to call SLFreeMemory to free the memory.
Return Error: Return Error:
E_INVALIDARG E_INVALIDARG
SL_E_VALUE_NOT_FOUND SL_E_VALUE_NOT_FOUND
SL_E_RIGHT_NOT_GRANTED Other error codes.
--*/ --*/
__control_entrypoint(DllExport)
HRESULT HRESULT
WINAPI WINAPI
SLGetWindowsInformationDWORD( SLGetWindowsInformationDWORD(
__in PCWSTR pwszValueName, _In_ PCWSTR pwszValueName,
__out DWORD* pdwValue _Out_ DWORD* pdwValue
); );
/*++ /*++
Routine Description: Routine Description:
This function is used to for Windows components to get This function is used to for Windows components to get
component policy DWORD value. component policy DWORD value.
Arguments: Arguments:
pwszValueName pwszValueName
The name of the requested value. The name of the requested value.
pdwValue pdwValue
The buffer to receive DWORD value The buffer to receive DWORD value
Return Error: Return Error:
E_INVALIDARG E_INVALIDARG
SL_E_VALUE_NOT_FOUND SL_E_VALUE_NOT_FOUND
SL_E_RIGHT_NOT_GRANTED
SL_E_DATATYPE_MISMATCHED SL_E_DATATYPE_MISMATCHED
Other error codes.
--*/ --*/
__control_entrypoint(DllExport)
HRESULT HRESULT
WINAPI WINAPI
SLIsGenuineLocal( SLIsGenuineLocal(
__in CONST SLID* pAppId, _In_ CONST SLID* pAppId,
__out SL_GENUINE_STATE* pGenuineState, _Out_ SL_GENUINE_STATE* pGenuineState,
__inout_opt SL_NONGENUINE_UI_OPTIONS* pUIOptions _Inout_opt_ SL_NONGENUINE_UI_OPTIONS* pUIOptions
); );
/*++ /*++
Routine Description: Routine Description:
Determines if an installation is a Genuine installation. Determines if an installation is a Genuine installation.
It interrogates the license for pAppId and inspects the "Tampered" It interrogates the license for pAppId and inspects the "Tampered"
flag. If either the license for pAppId is invalid or the "Tampered" flag. If either the license for pAppId is invalid or the "Tampered"
flag is set, the installation is assumed to be invalid. flag is set, the installation is assumed to be invalid.
pGenuineState is ONLY modified if the result is S_OK. Otherwise, it is pGenuineState is ONLY modified if the result is S_OK. Otherwise, it is
skipping to change at line 179 skipping to change at line 1842
Return Error: Return Error:
S_OK S_OK
Operation completed successfully. Operation completed successfully.
E_INVALIDARG E_INVALIDARG
pGenuineState is NULL. pGenuineState is NULL.
--*/ --*/
__control_entrypoint(DllExport)
HRESULT HRESULT
WINAPI WINAPI
SLIsGenuineLocalEx( SLIsGenuineLocalEx(
__in CONST SLID* pAppId, _In_ CONST SLID* pAppId,
__in_opt CONST SLID* pSkuId, _In_opt_ CONST SLID* pSkuId,
__out SL_GENUINE_STATE* pGenuineState _Out_ SL_GENUINE_STATE* pGenuineState
); );
/*++ /*++
Routine Description: Routine Description:
Determines if an installation is a Genuine installation. Determines if an installation is a Genuine installation.
If the SkuId is provided, it is used for the primary check. If the Sku lice nse If the SkuId is provided, it is used for the primary check. If the Sku lice nse
contains a ProductUniquenessGroupId value, that is also used. Finally, the AppId is used. contains a ProductUniquenessGroupId value, that is also used. Finally, the AppId is used.
If the AppId, ProductUniquenessGroupId, or SkuId contains a "Tampered" flag or if the license If the AppId, ProductUniquenessGroupId, or SkuId contains a "Tampered" flag or if the license
state is invalid or "Tampered", the installation is assumed to be invalid. state is invalid or "Tampered", the installation is assumed to be invalid.
skipping to change at line 221 skipping to change at line 1883
Return Error: Return Error:
S_OK S_OK
Operation completed successfully. Operation completed successfully.
E_INVALIDARG E_INVALIDARG
pGenuineState is NULL. pGenuineState is NULL.
--*/ --*/
__control_entrypoint(DllExport)
HRESULT HRESULT
WINAPI WINAPI
SLAcquireGenuineTicket( SLAcquireGenuineTicket(
__deref_out_bcount(*pcbTicketBlob) VOID** ppTicketBlob, _Outptr_result_bytebuffer_(*pcbTicketBlob) VOID** ppTicketBlob,
__out UINT* pcbTicketBlob, _Out_ UINT* pcbTicketBlob,
__in PCWSTR pwszTemplateId, _In_ PCWSTR pwszTemplateId,
__in PCWSTR pwszServerUrl, _In_ PCWSTR pwszServerUrl,
__in_opt PCWSTR pwszClientToken _In_opt_ PCWSTR pwszClientToken
); );
/*++ /*++
Routine Description: Routine Description:
Returns genuine ticket acquired from Software Licensing Server based Returns genuine ticket acquired from Software Licensing Server based
on SLWGA template blob. on SLWGA template blob.
The client is responsible for freeing the buffer returned in ppGenuineBlob. The client is responsible for freeing the buffer returned in ppGenuineBlob.
SLWGAFreeMemory should be used to free the memory. SLWGAFreeMemory should be used to free the memory.
skipping to change at line 268 skipping to change at line 1929
pwszClientToken pwszClientToken
Client custom token. Client custom token.
Return Error: Return Error:
S_OK S_OK
Operation completed successfully. Operation completed successfully.
--*/ --*/
__control_entrypoint(DllExport)
HRESULT HRESULT
WINAPI WINAPI
SLSetGenuineInformation( SLSetGenuineInformation(
__in CONST SLID* pAppId, _In_ CONST SLID* pQueryId,
__in PCWSTR pwszValueName, _In_ PCWSTR pwszValueName,
__in SLDATATYPE eDataType, _In_ SLDATATYPE eDataType,
__in_opt UINT cbValue, _In_opt_ UINT cbValue,
__in_bcount_opt(cbValue) CONST BYTE* pbValue _In_reads_bytes_opt_(cbValue) CONST BYTE* pbValue
); );
/*++ /*++
Routine Description: Routine Description:
This function sets genuine information. This function sets genuine related information.
Arguments: Arguments:
pAppId pQueryId
Application Id. E.g. Windows AppId pQueryId can be one of the following.
ApplicationId in case of querying following property values.
SL_PROP_BRT_DATA
SL_PROP_BRT_COMMIT
SKUId in case of querying following property values.
SL_PROP_LAST_ACT_ATTEMPT_HRESULT
SL_PROP_LAST_ACT_ATTEMPT_TIME
SL_PROP_LAST_ACT_ATTEMPT_SERVER_FLAGS
SL_PROP_ACTIVATION_VALIDATION_IN_PROGRESS
pwszValueName pwszValueName
The name of value. pwszValueName can be one of the following property names.
TBD SL_PROP_BRT_DATA
SL_PROP_BRT_COMMIT
SL_PROP_LAST_ACT_ATTEMPT_HRESULT
SL_PROP_LAST_ACT_ATTEMPT_TIME
SL_PROP_LAST_ACT_ATTEMPT_SERVER_FLAGS
SL_PROP_ACTIVATION_VALIDATION_IN_PROGRESS
eType eType
See SLDATATYPE See SLDATATYPE
cbValue cbValue
Size of value Size of value
pbValue pbValue
Value. Value.
Some properties allows NULL pointer, which can be used to delete Some properties allows NULL pointer, which can be used to delete
the property but some properties can't. the property but some properties can't.
Return Value: Return Value:
HRESULT_FROM_WIN32(ERROR_BUFFER_OVERFLOW) HRESULT_FROM_WIN32(ERROR_BUFFER_OVERFLOW)
The size of value is over expected size The size of value is over expected size
E_ACCESSDENIED E_ACCESSDENIED
Admin privilege required Admin privilege required
E_INVALIDARG E_INVALIDARG
Some property does not allow NULL value Some property does not allow NULL value
SL_E_NOT_SUPPORTED SL_E_NOT_SUPPORTED
The name of value is not supported The name of value is not supported
SL_E_DEPENDENT_PROPERTY_NOT_SET SL_E_DEPENDENT_PROPERTY_NOT_SET
If entry has been set If entry has been set
SL_E_DATATYPE_MISMATCHED SL_E_DATATYPE_MISMATCHED
The type of data is mismatched with the expected type The type of data is mismatched with the expected type
skipping to change at line 320 skipping to change at line 1996
Some property does not allow NULL value Some property does not allow NULL value
SL_E_NOT_SUPPORTED SL_E_NOT_SUPPORTED
The name of value is not supported The name of value is not supported
SL_E_DEPENDENT_PROPERTY_NOT_SET SL_E_DEPENDENT_PROPERTY_NOT_SET
If entry has been set If entry has been set
SL_E_DATATYPE_MISMATCHED SL_E_DATATYPE_MISMATCHED
The type of data is mismatched with the expected type The type of data is mismatched with the expected type
of specified value name of specified value name
--*/ --*/
HRESULT
WINAPI
SLGetReferralInformation(
_In_ HSLC hSLC,
_In_ SLREFERRALTYPE eReferralType,
_In_ CONST SLID* pSkuOrAppId,
_In_ PCWSTR pwszValueName,
_Outptr_ PWSTR* ppwszValue
);
/*++
SLGetReferralInformation
Routine Description:
Associates information with the specified product
Arguments:
hSLC
Handle retrieved by previous call to SLOpen
eReferralType
Do we want to obtain application or SKU specific referral information
pSkuOrAppId
Application or SKU from which to obtain referral information
pwszValueName
The value name for the associated data.
Allowable value pairs:
SL_PARTNERID
Partner Id for the license reseller
SL_REFERRALID
Referral ID for the license reseller
SL_MERCHANTCOMMERCEURL
The merchant URL to purchase additional licenses
SL_MERCHANTUPGRADEURL
The merchant URL to purchase additional licenses
SL_DOWNLOADURL
A forward link to download the associated application
SL_INSTALLATIONPARAMETERS
Any parameters that are used when running the associated app
lication's installer
SL_MERCHANTSUPPORTPHONENUMBER
The merchant support phone number(s)
SL_MERCHANTSUPPORTEMAIL
The merchant support email address
SL_MERCHANTSUPPORTURL
The merchant support URL
SL_SERIALIZEDDATA
A generic data blob
pwszValue
The value to store
--*/
__control_entrypoint(DllExport) __control_entrypoint(DllExport)
HRESULT HRESULT
WINAPI WINAPI
SLGetGenuineInformation( SLPersistRTSPayloadOverride(
__in CONST SLID* pAppId, _In_ HSLC hSLC,
__in PCWSTR pwszValueName, _In_ CONST SLID* pApplicationId,
__out_opt SLDATATYPE* peDataType, _In_opt_ CONST SLID* pProductSkuId,
__out UINT* pcbValue, _In_reads_bytes_(cbData) BYTE* pbData,
__deref_out_bcount(*pcbValue) BYTE** ppbValue _In_ DWORD cbData
); );
/*++ /*++
SLPersistRTSPayloadOverride
Routine Description: Routine Description:
This function gets genuine information. Associates information with the specified product for online and phone act
ivation
Arguments:
hSLC
Handle retrieved by previous call to SLOpen
pApplicationId
Application Id to associate the payload data with
pProductSkuId
Optional Sku Id to associate the payload data with
pbData
The byte data that will be sent up during activation.
This API assumes the data is composed of a 20-bit value stored in the
first three bytes:
Byte[0] is the LSB of the HIWORD, Byte[1] is the HSB of the LOWORD, an
d Byte[2] is the LSB of the LOWORD.
Any value composed of these three bytes that exceeds 20 bits will be r
ejected with E_INVALIDARG
cbData
The number of bytes that will be stored. This must be equal to 3.
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLPersistApplicationPolicies(
_In_ CONST SLID* pApplicationId,
_In_opt_ CONST SLID* pProductSkuId,
_In_ DWORD dwFlags
);
/*++
Routine Description:
Stores the current consumed policies to the disk for fast policy access.
If the internal consumption fails then any current cache data is deleted
such that subsequent calls to SLLoadApplicationPolicies() will return
SL_E_APPLICATION_POLICIES_MISSING.
SLPersistApplicationPolicies returns success if the policy update succeeds,
regardless of internal consumption results.
Arguments:
pApplicationId
Identifier of the AppId to be used for the fast policy queries.
pProductSkuId
optional - Identifier of the ACID to be used for the fast policy queries
.
dwFlags
additional flags if any
Return Error:
E_INVALIDARG
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetApplicationPolicy(
_In_ HSLP hPolicyContext,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
Queries a policy from the set loaded set stored with SLPersistApplicationPol
icies
and loaded using SLLoadApplicationPolicies
Arguments:
hPolicyContext
Context handle returned by SLLoadApplicationPolicies
pwszValueName
the name of the policy to query, or '*' for all policies
peDataType
optional - returns the type of the data if data was available
pcbValue
returns the size of the data if data was available
ppbValue
returns the data if data was available
Return Error:
E_INVALIDARG
SL_E_APPLICATION_POLICIES_NOT_LOADED if the policy context was not found
SL_E_VALUE_NOT_FOUND if the policy is not found
SL_E_RIGHT_NOT_GRANTED if the policy list is empty
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLLoadApplicationPolicies(
_In_ CONST SLID* pApplicationId,
_In_opt_ CONST SLID* pProductSkuId,
_In_ DWORD dwFlags,
_Out_ HSLP* phPolicyContext
);
/*++
Routine Description:
Loads the application policies set with SLPersistApplicationPolicies
for use by the query function SLGetApplicationPolicy
Arguments:
pApplicationId
Identifier of the AppId to be used for the fast policy queries.
pProductSkuId
optional - Identifier of the ACID to be used for the fast policy queries
.
dwFlags
additional flags if any
pPolicyContext
pointer to a policy context for use in SLGetApplicationPolicy and
SLUnloadApplicationPolicies
Return Error:
E_INVALIDARG
SL_E_APPLICATION_POLICIES_MISSING if the policy list doesn't exist
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLUnloadApplicationPolicies(
_In_ HSLP hPolicyContext,
_In_ DWORD dwFlags
);
/*++
Routine Description:
Releases the policy context handle returned by SLLoadApplicationPolicies
Arguments:
hPolicyContext
Context handle returned by SLLoadApplicationPolicies
dwFlags
additional flags, if any
Return Error:
E_INVALIDARG
SL_E_APPLICATION_POLICIES_NOT_LOADED if the policy context was not found
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLGetAuthenticationResult(
_In_ HSLC hSLC,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) PBYTE* ppbValue
);
/*++
Routine Description:
This function gets the authentication results set by some SLAPI call.
Caller can use this result to verify the integrity of return data
of some SLAPI
Arguments: Arguments:
hSLC hSLC
Handle to current SLC session. Handle to current SLC context.
cbValue
Size of authentication result
pbValue
Authentication result
Return Value:
SL_E_AUTHN_MISMATCHED_KEY
The key used in SLSetAuthenticationData call is incorrect
SL_E_AUTHN_CANT_VERIFY
The authentication cannot be done. For example, right consumption is not
done or failed. Or
this feature is not enabled in licenses.
SL_E_AUTHN_CHALLENGE_NOT_SET
The authentication data (challenge) is not set
--*/
__control_entrypoint(DllExport)
HRESULT
WINAPI
SLSetAuthenticationData(
_In_ HSLC hSLC,
_In_opt_ UINT cbValue,
_In_reads_bytes_opt_(cbValue) CONST BYTE* pbValue
);
/*++
Routine Description:
This function lets caller set authentication data, so the caller
can authenticate the result from some SLAPI call.
Arguments:
hSLC
Handle to current SLC context.
cbValue
Size of authentication data
pbValue
Authentication data
Return Value:
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)
The format of authentication data is invalid
SL_E_AUTHN_WRONG_VERSION
The security version is wrong
SL_E_NOT_SUPPORTED
The authentication data format is not supported
--*/
HRESULT
WINAPI
SLGetGenuineInformation(
_In_ CONST SLID* pQueryId,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) BYTE** ppbValue
);
/*++
Routine Description:
This function gets genuine related information.
Arguments:
pQueryId
pQueryId can be one of the following.
GenuineId in case of querying following property values.
SL_PROP_GENUINE_RESULT
SL_PROP_GET_GENUINE_AUTHZ
ApplicationId in case of querying following property values.
SL_PROP_BRT_DATA
SL_PROP_BRT_COMMIT
SL_PROP_NONGENUINE_GRACE_FLAG
SKUId in case of querying following property values.
SL_PROP_LAST_ACT_ATTEMPT_HRESULT
SL_PROP_LAST_ACT_ATTEMPT_TIME
SL_PROP_LAST_ACT_ATTEMPT_SERVER_FLAGS
SL_PROP_ACTIVATION_VALIDATION_IN_PROGRESS
pwszValueName
pwszValueName can be one of the following property names.
SL_PROP_GENUINE_RESULT
SL_PROP_GET_GENUINE_AUTHZ:<sessiondId>
SL_PROP_BRT_DATA
SL_PROP_BRT_COMMIT
SL_PROP_NONGENUINE_GRACE_FLAG
SL_PROP_LAST_ACT_ATTEMPT_HRESULT
SL_PROP_LAST_ACT_ATTEMPT_TIME
SL_PROP_LAST_ACT_ATTEMPT_SERVER_FLAGS
SL_PROP_ACTIVATION_VALIDATION_IN_PROGRESS
eType
See SLDATATYPE
cbValue
Size of value
pbValue
Value
Return Value:
SL_E_NOT_SUPPORTED
The name of value is not supported
SL_E_VALUE_NOT_FOUND
The specified value can not be found
--*/
HRESULT
WINAPI
SLGetGenuineInformationEx(
_In_ CONST SLID* pAppId,
_In_ PCWSTR pwszValueName,
_Out_opt_ SLDATATYPE* peDataType,
_Out_ UINT* pcbValue,
_Outptr_result_bytebuffer_(*pcbValue) BYTE** ppbValue
);
/*++
Routine Description:
This function gets genuine information.
Arguments:
pAppId pAppId
Application ID. E.g. Windows AppId Application ID. E.g. Windows AppId
pwszValueName pwszValueName
See SLSetOfflineGenuineInformation Name of the property
eType eType
See SLDATATYPE See SLDATATYPE
cbValue cbValue
Size of value Size of value
pbValue pbValue
Value Value
Return Value: Return Value:
SL_E_NOT_SUPPORTED SL_E_NOT_SUPPORTED
The name of value is not supported The name of value is not supported
SL_E_VALUE_NOT_FOUND SL_E_VALUE_NOT_FOUND
The specified value can not be found The specified value can not be found
SL_E_NOT_GENUINE
The Application licensing state is non-genuine
--*/
HRESULT
WINAPI
SLGatherMigrationBlob(
_In_ BOOL bMigratableOnly,
_In_opt_ LPCWSTR pwszEncryptorUri,
_In_ HANDLE hFile
);
/*+
Routine Description:
Gathers licensing information into provided file handle. This licensing info
rmation
can later be applied/deposited using SLDepositMigrationBlob.
Arguments:
bMigratableOnly
Specifies if only migratable data should be gathered
pwszEncryptorUri
URI of key to use for encrypting session key used to encrypt
any sensitive data in the output blob.
Only valid values are NULL and SL_DEFAULT_MIGRATION_ENCRYPTOR_URI,
which both refer to the same key.
hFile
File handle to where licensing state blob should be written.
Return Error:
S_OK
Operation completed successfully
E_INVALIDARG
One or more arguments are invalid
E_ACCESSDENIED
Access denied (API requires admin privileges)
--*/
HRESULT
WINAPI
SLGatherMigrationBlobEx(
__in DWORD dwFlags,
__in_opt LPCWSTR pwszEncryptorUri,
__in HANDLE hFile
);
/*+
Routine Description:
Gathers licensing information into provided file handle. This licensing info
rmation
can later be applied/deposited using SLDepositMigrationBlob.
Arguments:
dwFlags
Specifies which data types should be migrated. Allowed flags:
SPP_MIGRATION_GATHER_MIGRATABLE_APPS
Any license and corresponding product key data that is marked as mig
ratable
SPP_MIGRATION_GATHER_ACTIVATED_WINDOWS_STATE
Migrate the current active Windows license and product key
SPP_MIGRATION_GATHER_ALL
Migrate all licenses and corresponding product key data
pwszEncryptorUri
URI of key to use for encrypting session key used to encrypt
any sensitive data in the output blob.
Only valid values are NULL and SL_DEFAULT_MIGRATION_ENCRYPTOR_URI,
which both refer to the same key.
hFile
File handle to where licensing state blob should be written.
Return Error:
S_OK
Operation completed successfully
E_INVALIDARG
One or more arguments are invalid
E_ACCESSDENIED
Access denied (API requires admin privileges)
--*/
HRESULT
WINAPI
SLDepositMigrationBlob(
_In_ HANDLE hFile
);
/*+
Routine Description:
Deposits licensing information previously collected/gathered using SLGatherM
igrationBlob.
Arguments:
hFile
File handle from which licensing state blob should be read.
Return Error:
S_OK
Operation completed successfully
E_INVALIDARG
One or more arguments are invalid
E_ACCESSDENIED
Access denied (API requires admin privileges)
--*/ --*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */
#pragma endregion
#endif #endif
 End of changes. 34 change blocks. 
53 lines changed or deleted 2279 lines changed or added

This html diff was produced by rfcdiff 1.41.