The FileSelector Object: 3.2 File Selector Instance Data: The GFSI_fileCriteria Field

GFSI_fileCriteria, MSG_GEN_FILE_SELECTOR_GET_FILE_CRITERIA, MSG_GEN_FILE_SELECTOR_SET_FILE_CRITERIA

Each File Selector can limit or extend its searches in several different ways. The File Selector's instance data contains information about which types of files to include in the display, which not to include, and other special criteria. (Note that if the proper GFSI_attrs are set, directories and volumes will be unaffected by these scan limitations.)

The attribute field GFSI_fileCriteria is a record that indicates which of several search limiters should be considered in a directory scan. Note that some limitations may be invoked without a corresponding GFSI_fileCriteria entry. There are several possible entries in GFSI_fileCriteria , and any or all may be turned on at once. Each flag in the field is shown below, along with the field that it affects:

FSFC_DIRS: This flag indicates that subdirectories should be displayed in the File Selector's directory scans. This flag is set by default.
FSFC_NON_GEOS_FILES: This flag indicates that non-GEOS files should be displayed. This flag is set by default.
FSFC_GEOS_EXECUTABLES: This flag indicates that GEOS executable files should be displayed. This flag is set by default.
FSFC_GEOS_NON_EXECUTABLES: This flag indicates that GEOS non-executable files (documents and other types) should be displayed. This flag is set by default.
FSFC_MASK_CASE_INSENSITIVE: This flag indicates that the filename mask (if any) should be case-insensitive. The mask applies only to files unless FSFC_USE_MASK_FOR_DIRS is also set (see below); the mask is set in ATTR_GEN_FILE_SELECTOR_NAME_MASK .
FSFC_FILE_FILTER: This flag makes the File Selector use an application-defined callback routine when scanning. The callback routine is used after all other filters have been applied. The callback routine must be defined in a subclass of GenFileSelectorClass .
FSFC_FILTER_IS_C: This flag indicates that the callback filter routine is written in C and follows the Pascal calling convention.
FSFC_TOKEN_NO_ID: This flag indicates that when using a token to match files, the File Selector should ignore the token ID. In other words, it will only match the token characters.
FSFC_USE_MASK_FOR_DIRS: This flag indicates that if a filename mask is used, the File Selector should apply the mask to directories as well as to files. By default, the mask is applied only to file names.

You should set the proper GFSI_fileCriteria attributes in your application's Goc code. However, you can change the GFSI_fileCriteria field at run-time with MSG_GEN_FILE_SELECTOR_SET_FILE_CRITERIA . You can also get the flags with MSG_GEN_FILE_SELECTOR_GET_FILE_CRITERIA . Both of these messages are detailed below.

MSG_GEN_FILE_SELECTOR_SET_FILE_CRITERIA

void	MSG_GEN_FILE_SELECTOR_SET_FILE_CRITERIA(
        FileSelectorFileCriteria fileCriteria);

This message sets the File Selector'sGFSI_fileCriteria record to a new set of flags. If the File Selector is visible when it receives this message, it will rescan the current directory with the new attributes. Otherwise, it will set the GFSI_fileCriteria record but will not rescan.

Source: Unrestricted.

Destination: Any GenFileSelector object.

Parameters: fileCriteria A record of FileSelectorFileCriteria to set into the File Selector's GFSI_fileCriteria record.

Return: Nothing.

Interception: Generally not intercepted.

See Also: MSG_GEN_FILE_SELECTOR_SET_FILE_ATTRS , MSG_GEN_FILE_SELECTOR_SET_TOKEN , MSG_GEN_FILE_SELECTOR_SET_CREATOR , MSG_GEN_FILE_SELECTOR_SET_GEODE_ATTRS , MSG_GEN_FILE_SELECTOR_SET_MASK

MSG_GEN_FILE_SELECTOR_GET_FILE_CRITERIA

FileSelectorFileCriteria MSG_GEN_FILE_SELECTOR_GET_FILE_CRITERIA();

This message returns the File Selector's current GFSI_fileCriteria record.

Source: Unrestricted.

Destination: Any GenFileSelector object.

Parameters: None.

Return: A record of FileSelectorFileCriteria representing the File Selector's GFSI_fileCriteria flags.

Interception: Generally not intercepted.

See Also: MSG_GEN_FILE_SELECTOR_SET_FILE_ATTRS , MSG_GEN_FILE_SELECTOR_SET_TOKEN , MSG_GEN_FILE_SELECTOR_SET_CREATOR , MSG_GEN_FILE_SELECTOR_SET_GEODE_ATTRS , MSG_GEN_FILE_SELECTOR_SET_MASK

GEOS SDK TechDocs |

3.1 The GFSI_attrs Field | Next:

3.3 Matching a File's Token