função ldap_search_init_page (winldap.h)
A função ldap_search_init_page inicializa um bloco de pesquisa para uma pesquisa de resultados paginado simples. Essa função tem suporte no LDAP 3.
Sintaxe
WINLDAPAPI PLDAPSearch LDAPAPI ldap_search_init_page(
[in] PLDAP ExternalHandle,
[in] const PSTR DistinguishedName,
[in] ULONG ScopeOfSearch,
[in] const PSTR SearchFilter,
[in] PZPSTR AttributeList,
[in] ULONG AttributesOnly,
[in] PLDAPControl *ServerControls,
[in] PLDAPControl *ClientControls,
[in] ULONG PageTimeLimit,
[in] ULONG TotalSizeLimit,
[in] PLDAPSortKey *SortKeys
);
Parâmetros
[in] ExternalHandle
O identificador de sessão.
[in] DistinguishedName
Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome diferenciado da entrada na qual iniciar a pesquisa.
[in] ScopeOfSearch
Um tipo de dados que especifica um dos valores a seguir para indicar o escopo da pesquisa.
LDAP_SCOPE_BASE
Pesquisar somente a entrada base.
LDAP_SCOPE_ONELEVEL
Pesquise todas as entradas no primeiro nível abaixo da entrada base, excluindo a entrada base.
LDAP_SCOPE_SUBTREE
Pesquise a entrada base e todas as entradas na árvore abaixo da base.
[in] SearchFilter
Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o filtro de pesquisa. Para obter mais informações, consulte Sintaxe de filtro de pesquisa.
[in] AttributeList
Uma matriz terminada em nulo de cadeias de caracteres terminadas em nulo que indica quais atributos retornar para cada entrada correspondente. Passe NULL para recuperar todos os atributos disponíveis.
[in] AttributesOnly
Um valor booliano que deve ser zero se os tipos de atributo e os valores devem ser retornados, diferente de zero se apenas os tipos devem ser retornados.
[in] ServerControls
Uma lista de controles de servidor LDAP.
[in] ClientControls
Uma lista de controles de cliente.
[in] PageTimeLimit
O valor de tempo, em segundos, que o cliente aguardará até que o servidor retorne uma página.
[in] TotalSizeLimit
O número máximo de entradas que o cliente aceitará. O valor TotalSizeLimit afeta apenas as páginas individuais dentro da pesquisa paginada (não a pesquisa paginada geral). Portanto, se TotalSizeLimit for maior que o tamanho da página, TotalSizeLimit não terá efeito.
[in] SortKeys
Um ponteiro para uma estrutura LDAPSortKey , que especifica o tipo de atributo, a regra de ordenação e a direção da pesquisa.
Retornar valor
Se a função for bem-sucedida, ela retornará um ponteiro para uma estrutura LDAPSearch .
Se a função falhar, o valor retornado será NULL. Use LdapGetLastError ou GetLastError para recuperar o código de erro.
Chame o ldap_search_abandon_page para liberar a estrutura retornada.
Comentários
A função ldap_search_init_page cria uma estrutura LDAPSearch para gerenciar pesquisas paginados e retorna um identificador para a estrutura . As funções ldap_get_next_page, ldap_get_next_page_s e ldap_get_paged_count exigem esse identificador de pesquisa como um parâmetro. Quando a pesquisa paginada for concluída, chame ldap_search_abandon_page para liberar essa estrutura e seu identificador.
Para determinar se um servidor dá suporte a pesquisas de resultados paginados, marcar a propriedade supportedControl da raiz para um OID (identificador de objeto) de 1.2.840.113556.1.4.319.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows Vista |
| Servidor mínimo com suporte | Windows Server 2008 |
| Plataforma de Destino | Windows |
| Cabeçalho | winldap.h |
| Biblioteca | Wldap32.lib |
| DLL | Wldap32.dll |