TLSKeyPackEnumBegin function
Begins enumeration through all key packs that are installed on a Remote Desktop license server based on search criteria.
Note
This function has no associated header file or import library. To call this function, you must create a user-defined header file and use the LoadLibrary and GetProcAddress functions to dynamically link to Mstlsapi.dll.
Syntax
DWORD WINAPI TLSKeyPackEnumBegin(
_In_ TLS_HANDLE hHandle,
_In_ DWORD dwSearchParm,
_In_ BOOL bMatchAll,
_In_ LSKeyPack *lpSearchParm,
_Out_ PDWORD pdwErrCode
);
Parameters
-
hHandle [in]
-
Handle to a Remote Desktop license server. Specify a handle that is opened by the TLSConnectToLsServer function.
-
dwSearchParm [in]
-
Specifies the search criteria. This parameter is reserved for future use and must contain 0xFFFFFFFF.
-
bMatchAll [in]
-
Specifies whether to match all search values.
-
lpSearchParm [in]
-
Pointer to a LSKeyPack structure that specifies the search parameters to look for.
-
pdwErrCode [out]
-
Pointer to a variable that receives one of the following error codes on return.
-
LSERVER_S_SUCCESS (0)
-
Call is successful.
-
LSERVER_E_INTERNAL_ERROR (5001)
-
Internal error in license server.
-
LSERVER_E_INVALID_SEQUENCE (5006)
-
The calling sequence was not valid. Most likely, a previous enumeration has not ended.
-
LSERVER_E_SERVER_BUSY (5007)
-
License server is too busy to process the request.
-
LSERVER_E_OUTOFMEMORY (5008)
-
Cannot process the request because of insufficient memory.
-
LSERVER_E_INVALID_DATA (5009)
-
Data in the search parameter is not valid.
Return value
This function returns the following possible return values.
-
RPC_S_OK
-
The call succeeded. Check the value of the pdwErrCode parameter to get the return code for the call.
-
RPC_S_INVALID_ARG
-
The argument was not valid.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista |
| Minimum supported server |
Windows Server 2008 |
| DLL |
|