This topic has not yet been rated - Rate this topic

TLSLicenseEnumNext function

Continues from a previous call to the TLSLicenseEnumBegin function and returns the next license that is installed on a Remote Desktop license server that matches the 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

C++


DWORD WINAPI TLSLicenseEnumNext(
  _In_   TLS_HANDLE hHandle,
  _In_   LSLicense *lpLicense,
  _Out_  PDWORD pdwErrCode
);

Parameters

hHandle [in]

Handle to a Remote Desktop license server. Specify a handle that is opened by the TLSConnectToLsServer function.

lpLicense [in]

Pointer to a LSLicense structure that receives the next license that matches the search criteria.

pdwErrCode [out]

Pointer to a variable that receives one of the following error codes on return.

Value	Meaning
LSERVER_S_SUCCESS 0	Call is successful.
LSERVER_I_NO_MORE_DATA 4001	No more licenses match the search criteria.
LSERVER_E_INTERNAL_ERROR 5001	Internal error in license server.
LSERVER_E_INVALID_SEQUENCE 5006	The calling sequence was not valid. Must call the TLSLicenseEnumBegin() function before this.
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.

Return value

This function returns the following possible return values.

Return code	Description
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

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
DLL	Mstlsapi.dll

Community Additions