funzione ldap_create_sort_control (winldap.h)

La funzione ldap_create_sort_control viene usata per formattare un elenco di chiavi di ordinamento in un controllo di ricerca. Il supporto per i controlli è disponibile con LDAP 3, ma se il controllo di ordinamento è supportato o meno dipende dal server specifico.

Sintassi

WINLDAPAPI ULONG LDAPAPI ldap_create_sort_control(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPSortKeyA *SortKeys,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlA *Control
);

Parametri

[in] ExternalHandle

Handle di sessione.

[in] SortKeys

Puntatore a una matrice di strutture LDAPSortKey . Ogni struttura nella matrice specifica il nome di un attributo da usare come chiave di ordinamento, la regola corrispondente per tale chiave e se l'ordine di ordinamento è crescente o decrescente.

[in] IsCritical

Notifica al server se questo controllo è fondamentale per la ricerca. 0 ==> FALSE, !0 ==> TRUE.

[out] Control

Puntatore al controllo appena creato.

Valore restituito

Questa funzione restituisce WINLDAPAPI ULONG LDAPAPI.

Commenti

La funzione ldap_create_sort_control crea un controllo di ordinamento di base. Tale controllo è utile quando il client LDAP ha funzionalità limitate e non può ordinare i risultati, ma ne ha bisogno.

I controlli di ordinamento consentono a un server di restituire un codice di risultato per l'ordinamento dei risultati indipendenti dal codice di risultato restituito per l'operazione di ricerca.

Questa funzione crea il controllo: non verifica che il server lo supporti e di conseguenza non restituisce LDAP_UNAVAILABLE_CRIT_EXTENSION se il server non supporta il controllo. Tuttavia, può restituire altri valori restituiti LDAP standard, ad esempio LDAP_NO_MEMORY o LDAP_PARAM_ERROR.

Per liberare il controllo quando non è più necessario, chiamare ldap_control_free.

Requisiti

Vedi anche

Funzioni

LDAPSortKey

LDAP_SERVER_SORT_OID

ldap_control_free