ldap_check_filter

The ldap_check_filter function is used to verify filter syntax.

ULONG ldap_check_filter(
  LDAP* ld,
  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 Values

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

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Unicode: Implemented as Unicode and ANSI versions on all platforms.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, ldap_search, Return Values