Skip to content

Latest commit

 

History

History
142 lines (90 loc) · 4.83 KB

nf-winldap-ldap_compare_ext.md

File metadata and controls

142 lines (90 loc) · 4.83 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winldap.ldap_compare_ext
ldap_compare_ext function (winldap.h)
The ldap_compare_ext function (winldap.h) determines if an attribute, for a given entry, holds a known value.
_ldap_ldap_compare_ext
ldap.ldap__compare__ext
ldap.ldap_compare_ext
ldap_compare_ext
ldap_compare_ext function [LDAP]
ldap_compare_extA
ldap_compare_extW
winldap/ldap_compare_ext
winldap/ldap_compare_extA
winldap/ldap_compare_extW
ldap\ldap_compare_ext.htm
ldap
07e96a95-439b-4bb1-a9ca-d76d181e8bea
08/08/2022
_ldap_ldap_compare_ext, ldap.ldap__compare__ext, ldap.ldap_compare_ext, ldap_compare_ext, ldap_compare_ext function [LDAP], ldap_compare_extA, ldap_compare_extW, winldap/ldap_compare_ext, winldap/ldap_compare_extA, winldap/ldap_compare_extW
winldap.h
Windows
Windows Vista
Windows Server 2008
ldap_compare_extW (Unicode) and ldap_compare_extA (ANSI)
Wldap32.lib
Wldap32.dll
Windows
19H1
ldap_compare_ext
winldap/ldap_compare_ext
c++
APIRef
kbSyntax
DllExport
Wldap32.dll
ldap_compare_ext
ldap_compare_extA
ldap_compare_extW

ldap_compare_ext function

-description

Use the ldap_compare_ext function to determine if an attribute, for a given entry, holds a known value.

-parameters

-param ld [in]

The session handle.

-param dn [in]

A pointer to a null-terminated string that contains the distinguished name of the entry to compare.

-param Attr [in]

A pointer to a null-terminated string that contains the attribute to compare.

-param Value [in]

A pointer to a null-terminated string that contains the string attribute value to be compared to the attribute value.

-param Data [in]

The berval attribute value to be compared to the attribute value.

-param ServerControls [in]

Optional. A list of LDAP server controls. This parameter should be set to NULL if not used.

-param ClientControls [in]

Optional. A list of client controls. This parameter should be set to NULL if not used.

-param MessageNumber [out]

The message ID for the compare operation.

-returns

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.

-see-also

Extended Controls

Functions

Return Values

Using Controls

berval

ldap_compare

ldap_compare_ext_s

ldap_result