Filters items according to the text in a text field.
AFTKN_FILTER_SET_TEXT or 731
VOID FilterSetText(ENUM FilterHandleType; ENUM Field; ANSISTRING FieldText; ENUM Match; [ANSISTRING FieldName]; [ANSISTRING UserID])
Unique filter identifier, returned by FilterCreate():
Text field to filter. Use multiple commands to filter more than one field type. Text fields include:
625 |
Author! |
4 |
Authority! |
3 |
BC! |
6 |
Caller! Specifies caller's Name |
2 |
CC! |
7 |
Company! Specifies caller's Company |
626 |
Creator |
1 |
From! |
10 |
Message! If Message is selected, the BeginText! and FullText! filtering options cannot be used in the fourth parameter. |
331 |
NamedField! Specifies the custom Field name in the Optional FieldName parameter. |
8 |
Phone! Specifies caller's phone number. |
5 |
Place! |
9 |
Subject! |
227 |
TaskCategory! |
230 |
TaskPriority! |
0 |
To! |
267 |
ViewName! |
Text to match.
(Optional) SearchString in relation to the field contents. Position of the text in a character string. Specify as follows:
127 |
BeginText! Matches a string from the first charter to the length of the search string. If Message is selected for the second parameter, the BeginText! and FullText! filtering options cannot be used. |
165 |
FullText! Requires an exact match and is case-sensitive. If Message is selected for the second parameter, the BeginText! and FullText! filtering options cannot be used. |
225 |
SubText! Default. Matches any substrings. |
659 |
NotContainText! |
(Optional)
(Optional)
NamedFields is not available as ENUMS. Instead, use the NamedField (331) ENUM and specify the string in quotes as the FieldName.
For example, FilterSetText(315; 331; "Document"; 225; "NGW_HWZ_DOC_TYPE") Document Type "NGW_HWZ_DOC_TYPE"Filename Extension "NGW_HWZ_FILENAME"Version Description "NGW_HWZ_VERSION_DESCRIPTION"Subclass "NGW_HWZ_ITEM_SUBTYPE"Posted By "NGW_HSZ_SHARER_FULL_NAME"Caller's Phone Number "CALLER_PHONE_NUMBER"Caller's Company "CALLER_COMPANY_TEXT"Library "NGW_HWZ_LIB_DISPLAY_NAME"Opened By "NGW_HWZ_VER_RET_BY_DISPLAY_NAME"Version Creator "NGW_HWZ_VER_CREATOR_DISPLAY_NAME"