Compartilhar via


Função WSALookupServiceBeginW (winsock2.h)

A função WSALookupServiceBegin inicia uma consulta de cliente restrita pelas informações contidas em uma estrutura de WSAQUERYSET . WSALookupServiceBegin retorna apenas um identificador, que deve ser usado por chamadas subsequentes para WSALookupServiceNext para obter os resultados reais.

Sintaxe

INT WSAAPI WSALookupServiceBeginW(
  [in]  LPWSAQUERYSETW lpqsRestrictions,
  [in]  DWORD          dwControlFlags,
  [out] LPHANDLE       lphLookup
);

Parâmetros

[in] lpqsRestrictions

Um ponteiro para os critérios de pesquisa. Consulte os Comentários para obter detalhes.

[in] dwControlFlags

Um conjunto de sinalizadores que controla a profundidade da pesquisa.

Os valores com suporte para o parâmetro dwControlFlags são definidos no arquivo de cabeçalho Winsock2.h e podem ser uma combinação das opções a seguir.

Bandeira Significado
LUP_DEEP
0x0001
Consultas profundas em vez de apenas o primeiro nível.
LUP_CONTAINERS
0x0002
Retorna somente contêineres.
LUP_NOCONTAINERS
0x0004
Não retorne contêineres.
LUP_NEAREST
0x0008
Se possível, retorna resultados na ordem de distância. A medida de distância é específica do provedor.
LUP_RETURN_NAME
0x0010
Recupera o nome como lpszServiceInstanceName.
LUP_RETURN_TYPE
0x0020
Recupera o tipo como lpServiceClassId.
LUP_RETURN_VERSION
0x0040
Recupera a versão como lpVersion.
LUP_RETURN_COMMENT
0x0080
Recupera o comentário como lpszComment.
LUP_RETURN_ADDR
0x0100
Recupera os endereços como lpcsaBuffer.
LUP_RETURN_BLOB
0x0200
Recupera os dados privados como lpBlob.
LUP_RETURN_ALIASES
0x0400
Todas as informações de alias disponíveis devem ser retornadas em chamadas sucessivas para WSALookupServiceNext e cada alias retornado terá o sinalizador RESULT_IS_ALIAS definido.
LUP_RETURN_QUERY_STRING
0x0800
Recupera a cadeia de caracteres de consulta usada para a solicitação.
LUP_RETURN_ALL
0x0FF0
Um conjunto de sinalizadores que recupera todos os valores LUP_RETURN_*.
LUP_FLUSHPREVIOUS
0x1000
Usado como um valor para o parâmetro dwControlFlags em WSALookupServiceNext. Definir esse sinalizador instrui o provedor a descartar o último conjunto de resultados, que era muito grande para o buffer especificado, e passar para o próximo conjunto de resultados.
LUP_FLUSHCACHE
0x2000
Se o provedor tiver armazenado em cache informações, ignorará o cache e consultará o namespace em si.
LUP_RES_SERVICE
0x8000
Isso indica se a resposta principal está na parte remota ou local de CSADDR_INFO estrutura. A outra parte precisa ser utilizável em ambos os casos.

[out] lphLookup

Um identificador a ser usado ao chamar WSALookupServiceNext para começar a recuperar o conjunto de resultados.

Valor de retorno

O valor retornado será zero se a operação tiver sido bem-sucedida. Caso contrário, o valor SOCKET_ERROR será retornado e um número de erro específico poderá ser recuperado chamando WSAGetLastError.

Código de erro Significado
WSA_NOT_ENOUGH_MEMORY
Não havia memória suficiente para executar a operação.
WSAEINVAL
Um ou mais parâmetros estavam ausentes ou inválidos para esse provedor.
WSANO_DATA
O nome foi encontrado no banco de dados, mas nenhum dado correspondente às restrições determinadas foi localizado.
WSANOTINITIALISED
O WS2_32.DLL não foi inicializado. O aplicativo deve primeiro chamar WSAStartup antes de chamar as funções do Windows Sockets.
WSASERVICE_NOT_FOUND
Nenhum serviço desse tipo é conhecido. O serviço não pode ser encontrado no espaço de nome especificado.

Esse erro será retornado para uma solicitação de descoberta de serviço bluetooth se nenhum dispositivo bluetooth remoto tiver sido encontrado.

Observações

O parâmetro lpqsRestrictions aponta para um buffer que contém uma estrutura de WSAQUERYSET . No mínimo, o dwSize membro do WSAQUERYSET deve ser definido para o comprimento do buffer antes de chamar a função WSALookupServiceBegin. Os aplicativos podem restringir a consulta especificando outros membros no WSAQUERYSET.

Na maioria dos casos, os aplicativos interessados apenas em um protocolo de transporte específico devem restringir sua consulta por família de endereços e protocolo usando o dwNumberOfProtocols e lpafpProtocols membros do WSAQUERYSET em vez de especificar o namespace no membro dwNameSpace .

Informações sobre protocolos de transporte de rede com suporte podem ser retraídas usando o EnumProtocols, WSAEnumProtocols, WSCEnumProtocolsou função de WSCEnumProtocols32.

Também é possível restringir a consulta a um único namespace. Por exemplo, uma consulta que deseja apenas resultados de DNS (não resultados do arquivo de hosts locais e outros serviços de nomenclatura) definiria o membro dwNameSpace como NS_DNS. Por exemplo, uma descoberta de dispositivo bluetooth definiria o membro dwNameSpace como NS_BTH.

Os aplicativos também podem restringir a consulta a um provedor de namespace específico especificando um ponteiro para o GUID para o provedor no membro lpNSProviderId.

Informações sobre provedores de namespace no computador local podem ser recuperadas usando o WSAEnumNameSpaceProviders, WSAEnumNameSpaceProvidersEx, WSCEnumNameSpaceProviders32ou função WSCEnumNameSpaceProvidersEx32.

Se LUP_CONTAINERS for especificado em uma chamada, outros valores de restrição deverão ser evitados. Se algum for especificado, cabe ao provedor de serviços de nome decidir se ele pode dar suporte a essa restrição sobre os contêineres. Se não puder, ele deverá retornar um erro.

Alguns provedores de serviços de nome podem ter outros meios de localizar contêineres. Por exemplo, todos os contêineres podem ser de algum tipo conhecido ou de um conjunto de tipos conhecidos e, portanto, uma restrição de consulta pode ser criada para encontrá-los. Não importa o que outro significa que o provedor de serviços de nome tem para localizar contêineres, LUP_CONTAINERS e LUP_NOCONTAINERS têm precedência. Portanto, se uma restrição de consulta for fornecida que inclua contêineres, especificar LUP_NOCONTAINERS impedirá que os itens de contêiner sejam retornados. Da mesma forma, independentemente da restrição de consulta, se LUP_CONTAINERS for fornecida, somente os contêineres deverão ser retornados. Se um namespace não der suporte a contêineres e LUP_CONTAINERS for especificado, ele deverá simplesmente retornar WSANO_DATA.

O método preferencial de obter os contêineres em outro contêiner é a chamada:

dwStatus = WSALookupServiceBegin(
      lpqsRestrictions,
      LUP_CONTAINERS,
      lphLookup);

Essa chamada é seguida pelo número necessário de chamadas WSALookupServiceNext. Isso retornará todos os contêineres contidos imediatamente no contexto inicial; ou seja, não é uma consulta profunda. Com isso, é possível mapear a estrutura de espaço de endereço percorrendo a hierarquia, talvez enumerando o conteúdo dos contêineres selecionados. Os usos subsequentes de WSALookupServiceBegin usar os contêineres retornados de uma chamada anterior.

Conforme mencionado acima, uma estrutura de WSAQUERYSET é usada como um parâmetro de entrada para WSALookupBegin para qualificar a consulta. A tabela a seguir indica como o WSAQUERYSET é usado para construir uma consulta. Quando um parâmetro é marcado como (opcional) um ponteiro NULL pode ser especificado, indicando que o parâmetro não será usado como um critério de pesquisa. Consulte a seção Query-Related Estruturas de Dados para obter informações adicionais.

Membro WSAQUERYSET Interpretação de consulta
dwSize Deve ser definido como sizeof(WSAQUERYSET). Esse é um mecanismo de controle de versão.
dwOutputFlags Ignorado para consultas.
lpszServiceInstanceName (Opcional) A cadeia de caracteres referenciada contém o nome do serviço. A semântica para curinga dentro da cadeia de caracteres não é definida, mas pode ser suportada por determinados provedores de namespace.
lpServiceClassId (Obrigatório) O GUID correspondente à classe de serviço.
lpVersion (Opcional) Referencia o número de versão desejado e fornece semântica de comparação de versão (ou seja, a versão deve corresponder exatamente ou a versão não deve ser menor do que o valor especificado).
lpszComment Ignorado para consultas.
dwNameSpace

Consulte a observação Importante a seguir.

Identificador de um único namespace no qual restringir a pesquisa ou NS_ALL incluir todos os namespaces.
lpNSProviderId (Opcional) Faz referência ao GUID de um provedor de namespace específico e limita a consulta somente a esse provedor.
lpszContext (Opcional) Especifica o ponto inicial da consulta em um namespace hierárquico.
dwNumberOfProtocols O tamanho da matriz de restrição de protocolo pode ser zero.
lpafpProtocols (Opcional) Faz referência a uma matriz de estrutura de AFPROTOCOLS. Somente os serviços que utilizam esses protocolos serão retornados.
lpszQueryString (Opcional) Alguns namespaces (como whois++) dão suporte a consultas enriquecidas semelhantes a SQL que estão contidas em uma cadeia de caracteres de texto simples. Esse parâmetro é usado para especificar essa cadeia de caracteres.
dwNumberOfCsAddrs Ignorado para consultas.
lpcsaBuffer Ignorado para consultas.
lpBlob (Opcional) Esse é um ponteiro para uma entidade específica do provedor.
 
Importante Na maioria das instâncias, os aplicativos interessados apenas em um protocolo de transporte específico devem restringir sua consulta por família de endereços e protocolo, em vez de por namespace. Isso permitiria que um aplicativo que precisa localizar um serviço TCP/IP, por exemplo, tivesse sua consulta processada por todos os namespaces disponíveis, como o arquivo de hosts local, O DNS e o NIS.
 
Windows Phone 8: a função WSALookupServiceBeginW tem suporte para aplicativos da Windows Phone Store no Windows Phone 8 e posterior.

windows 8.1 e windows server 2012 R2: a função WSALookupServiceBeginW tem suporte para aplicativos da Windows Store no Windows 8.1, Windows Server 2012 R2 e posterior.

Nota

O cabeçalho winsock2.h define WSALookupServiceBegin como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito Valor
de cliente com suporte mínimo Windows 8.1, Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
servidor com suporte mínimo Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP]
da Plataforma de Destino Windows
cabeçalho winsock2.h
biblioteca Ws2_32.lib
de DLL Ws2_32.dll

Consulte também

Bluetooth e WSALookupServiceBegin

EnumProtocols

WSAEnumNameSpaceProviders

WSAEnumNameSpaceProvidersEx

WSAEnumProtocols

WSALookupServiceEnd

WSALookupServiceNext

WSAQUERYSET

WSCEnumNameSpaceProviders32

WSCEnumNameSpaceProvidersEx32

WSCEnumProtocols

WSCEnumProtocols32