Export (0) Print
Expand All
Expand Minimize

ldap_check_filter function

The ldap_check_filter function is used to verify filter syntax.

Syntax


ULONG ldap_check_filter(
  _In_  LDAP *ld,
  _In_  PWCHAR SearchFilter
);

Parameters

ld [in]

The session handle.

SearchFilter [in]

A pointer to a wide, null-terminated string that contains the name of the filter to check.

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.

Remarks

Use ldap_check_filter to verify the syntax of a search filter before initiating a search. This syntax check does not perform a full verification of the search filter syntax against RFC 2254 rules. Rather, it verifies that the filter meets the minimum syntactic requirements for encoding required by the wldap32 search-filter-encoding routines. As a result, a search filter can pass an ldap_check_filter operation, and can be encoded by wldap32, but the server may still detect a RFC 2254 compliance violation and reject the search filter.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Header

Winldap.h

Library

Wldap32.lib

DLL

Wldap32.dll

Unicode and ANSI names

ldap_check_filterW (Unicode) and ldap_check_filterA (ANSI)

See also

Functions
ldap_search
Return Values

 

 

Show:
© 2014 Microsoft