Filter Functions

Before populating a container, your application can set filters on the container to specify criteria used to select the folders to retrieve from the site database.

Your application can configure a filter by adding tokens to the filter. There are two types of tokens: expression tokens and control tokens. An expression token defines how to search for objects that have a specified relationship to a specified value for a specified attribute. A control token can be a logical operator or parentheses. A logical operator defines the relationship between two adjacent expressions. Parentheses enable expressions to be grouped together.

The filter functions enable your application to create and close filters, add tokens to a filter, manipulate existing tokens (delete, exclude, group, and ungroup), get the count of tokens within a filter, and get the filter type. The SmsGetAllFilters function enables your application to retrieve the list of filters applied to a container.

Note that the token functions (SmsAddToken, SmsGetToken, SmsGetTokenCount, and SmsManipulateTokens) are also used to add and manage the tokens in an inventory rules folder (F_INVENTORY). In an inventory rules folder, each expression token represents the criteria used to identify a file. The set of tokens in an inventory rules folder represents the rule used to identify the package.

SmsAddToken

SmsCloseFilter

SmsCreateFilter

SmsGetAllFilters

SmsGetFilterType

SmsGetToken

SmsGetTokenCount

SmsManipulateTokens