Função TLSLicenseEnumBegin

Artigo
06/12/2023

Inicia a enumeração de licenças emitidas pelo servidor de licenças da Área de Trabalho Remota com base nos critérios de pesquisa.

Observação

Essa função não tem nenhum arquivo de cabeçalho associado ou biblioteca de importação. Para chamar essa função, você deve criar um arquivo de cabeçalho definido pelo usuário e usar as funções LoadLibrary e GetProcAddress para vincular dinamicamente a Mstlsapi.dll.

Sintaxe

DWORD WINAPI TLSLicenseEnumBegin(
  _In_  TLS_HANDLE hHandle,
  _In_  DWORD      dwSearchParm,
  _In_  BOOL       bMatchAll,
  _In_  LSLicense  *lpSearchParm,
  _Out_ PDWORD     pdwErrCode
);

Parâmetros

hHandle [in]: Manipule para um servidor de licença da Área de Trabalho Remota. Especifique um identificador aberto pela função TLSConnectToLsServer .
dwSearchParm [in]: Especifica os critérios de pesquisa. O parâmetro pode ser uma ou uma combinação dos valores descritos na lista a seguir. O parâmetro especifica o tipo de pacote de chaves e qual pacote de chaves pesquisar.
LSLICENSE_SEARCH_LICENSEID (0x00000001): Pesquisar por ID de licença.
LSLICENSE_SEARCH_KEYPACKID (0x00000002): Pesquise por ID do pacote de chaves.
LSLICENSE_SEARCH_MACHINENAME (0x00000008): Pesquise pelo nome do computador.
LSLICENSE_SEARCH_USERNAME (0x00000010): Pesquise por nome de usuário.
LSLICENSE_SEARCH_ISSUEDATE (0x00000080): Pesquisar por data de emissão.
LSLICENSE_SEARCH_EXPIREDATE (0x00000100): Pesquisar por data de validade.
LSLICENSE_SEARCH_ NUMLICENSES (0x00000200): Pesquise por número de licenças.
LSLICENSE_SEARCH_ ENTRY_STATUS (0x20000000): Pesquise por status de entrada.
LSLICENSE_EXSEARCH_LICENSESTATUS (0x00100000): Pesquisar por status de licença.
LSKEYPACK_SEARCH_ALL (0xFFFFFFFF): Pesquise todas as licenças.

bMatchAll [in]

Especifica se todos os valores de pesquisa devem ser correspondidos.

lpSearchParm [in]

Ponteiro para uma estrutura LSLicense que especifica os parâmetros de pesquisa a serem procurados.

pdwErrCode [out]

Ponteiro para uma variável que recebe um dos seguintes códigos de erro no retorno.

LSERVER_S_SUCCESS (0)

A chamada foi bem-sucedida.

LSERVER_E_INTERNAL_ERROR (5001)

Erro interno no servidor de licença.

LSERVER_E_INVALID_SEQUENCE (5006)

A sequência de chamadas não era válida. Provavelmente, uma enumeração anterior não terminou.

LSERVER_E_SERVER_BUSY (5007)

O servidor de licença está muito ocupado para processar a solicitação.

LSERVER_E_OUTOFMEMORY (5008)

Não é possível processar a solicitação devido à memória insuficiente.

LSERVER_E_INVALID_DATA (5009)

Os dados no parâmetro de pesquisa não são válidos.

Valor retornado

Essa função retorna os seguintes valores de retorno possíveis.

RPC_S_OK: A chamada foi bem-sucedida. Verifique o valor do parâmetro pdwErrCode para obter o código de retorno da chamada.
RPC_S_INVALID_ARG: O argumento não era válido.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista
Servidor mínimo com suporte	Windows Server 2008
DLL	Mstlsapi.dll

Confira também

LSLicense
TLSConnectToLsServer
TLSLicenseEnumNext
TLSLicenseEnumEnd