Filter Object

The Filter object enables the application to specify a condition to which the enumeration result set must match. It is the server's responsibility to screen or filter the entire listing, and return only those results that match the specified filter.

There are two types of filters in the ILS interface:

• Simple filter, each of which specifies a basic condition in the form of <Attribute><Relative Operator><Value>.
• Composite filter, which is a logical accumulation of several simple filters. For example, "Last Name = Smith" is a simple filter, whereas "(LastName = Smith) AND ((FirstName != Mike) OR (FirstName != Jose))" is a composite filter.

Filters are created by the IIlsMain::CreateFilter or IIlsMain::StringToFilter method.

The Filter Object exposes the following interface:

IIlsFilter Interface

Back to ILS Reference

IIlsFilter Interface

The IIlsFilter interface is obtained from the IIlsMain::CreateFilter or IIlsMain::StringToFilter method. The interface provides the methods described in this section.

AddSubFilter

GetCount

RemoveSubFilter

SetAttributeValue

SetExtendedAttributeName

SetStandardAttributeName

Back to Filter Object

IIlsFilter::AddSubFilter

HRESULT IIlsFilter::AddSubFilter(
    IIlsFilter  *pFilter);

Adds a subfilter to the list of subfilters in a composite filter.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_FILTER_TYPE	Filter type is not ILS_FILTERTYPE_COMPOSITE.
  ILS_E_POINTER	Subfilter is not valid.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.

pFilter

Address of the subfilter to be appended.

This method applies to composite filter operations.

Back to IIlsFilter Interface

Back to Filter Object

Back to ILS Object Listing

IIlsFilter::GetCount

HRESULT IIlsFilter::GetCount(
    ULONG  *pcElements);

Counts the number of subfilters in a composite filter.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_FILTER_TYPE	Filter type is not ILS_FILTERTYPE_COMPOSITE.
  ILS_E_POINTER	Address of the return buffer is NULL.

pcElements

Address of a ULONG buffer where the count is returned.

This method applies to composite filter operations.

Back to IIlsFilter Interface

Back to Filter Object

Back to ILS Object Listing

IIlsFilter::RemoveSubFilter

HRESULT IIlsFilter::RemoveSubFilter(
    IIlsFilter  *pFilter);

Removes a subfilter from the list of subfilters in a composite filter.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_FILTER_TYPE	Filter type is not ILS_FILTERTYPE_COMPOSITE.
  ILS_E_POINTER	Subfilter is not valid.

pFilter

Address of the subfilter to be removed.

This method applies to composite filter operations.

Back to IIlsFilter Interface

Back to Filter Object

Back to ILS Object Listing

IIlsFilter::SetAttributeValue

HRESULT IIlsFilter::SetAttributeValue(
    BSTR bstrAttrValue);

Sets the value of a simple filter.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_FILTER_TYPE	Filter type is not ILS_FILTERTYPE_SIMPLE.
  ILS_E_POINTER	Attribute value string is NULL.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.

bstrAttrValue

Buffer holding the value that the simple filter is to match.

This method applies to simple filter operations.

Back to IIlsFilter Interface

Back to Filter Object

Back to ILS Object Listing

IIlsFilter::SetExtendedAttributeName

HRESULT IIlsFilter:: SetExtendedAttributeName(
    BSTR bstrAnyAttrName);

Sets the attribute of a simple filter to be a nonstandard ILS attribute.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_FILTER_TYPE	Filter type is not ILS_FILTERTYPE_SIMPLE.
  ILS_E_POINTER	Attribute name is NULL.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.

bstrAnyAttrName

Buffer holding the name of the nonstandard attribute.

This method applies to simple filter operations.

Back to IIlsFilter Interface

Back to Filter Object

Back to ILS Object Listing

IIlsFilter::SetStandardAttributeName

HRESULT IIlsFilter::SetStandardAttributeName(
    ILS_STD_ATTR_NAME  usrStdAttr);

Sets the attribute of a simple filter to be a standard ILS attribute.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_FILTER_TYPE	Filter type is not ILS_FILTERTYPE_SIMPLE.
  ILS_E_PARAMETER	Attribute name is incorrect.

usrStdAttr

Standard attribute to use for this filter.

This method applies to simple filter operations.

Back to IIlsFilter Interface

Back to Filter Object

Back to ILS Object Listing

Last Updated: November 1, 1997
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.