ldap_compare_extW function (winldap.h)
Use the ldap_compare_ext function to determine if an attribute, for a given entry, holds a known value.
Syntax
WINLDAPAPI ULONG LDAPAPI ldap_compare_extW(
[in] LDAP *ld,
[in] const PWSTR dn,
[in] const PWSTR Attr,
[in] const PWSTR Value,
[in] berval *Data,
[in] PLDAPControlW *ServerControls,
[in] PLDAPControlW *ClientControls,
[out] ULONG *MessageNumber
);
Parameters
[in] ld
The session handle.
[in] dn
A pointer to a null-terminated string that contains the distinguished name of the entry to compare.
[in] Attr
A pointer to a null-terminated string that contains the attribute to compare.
[in] Value
A pointer to a null-terminated string that contains the string attribute value to be compared to the attribute value.
[in] Data
The berval attribute value to be compared to the attribute value.
[in] ServerControls
Optional. A list of LDAP server controls. This parameter should be set to NULL if not used.
[in] ClientControls
Optional. A list of client controls. This parameter should be set to NULL if not used.
[out] MessageNumber
The message ID for the compare operation.
Return value
If the function succeeds, LDAP_SUCCESS is returned.
If the function fails, an error code is returned. For more information, see Return Values for more information.
Remarks
The ldap_compare_ext function initiates an asynchronous compare operation, comparing the value of an attribute to a known value. The parameters and effects of ldap_compare_ext subsume those of ldap_compare. The extended routine includes additional parameters to support client and server controls, comparison of binary values, and thread safety.
Use the Value parameter for comparing string values or use the Data parameter for comparing raw binary data. Set the unused parameter to NULL. If neither parameter is NULL, the compare operation will use the value in the Data parameter.
If successful, ldap_compare_ext passes back the message ID for the operation in the MessageNumber parameter. Call ldap_result with the message ID to obtain the result of the compare. To have the function return the compare result directly, use the synchronous extended compare function ldap_compare_ext_s.
Multithreading: Calls to ldap_compare_ext are thread-safe.
Note
The winldap.h header defines ldap_compare_ext as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | winldap.h |
| Library | Wldap32.lib |
| DLL | Wldap32.dll |