S&R plugins programming / Service functions / FS

Функция FS_Set используется для инициализации объекта "поиск файлов по дискам". Только после успешной инициализации вы можете использовать FS_Search.

Параметры

Указатель на объект.

searchmode

Режим поиска, может быть одним из следующих:

FSSM_SELECTION

Поиск в выделенном. Если среди выделенных объектов есть каталоги и разрешена обработка подкаталогов, то помимо обработке выделенных файлов происходит поиск по маске в выделенных подкаталогах.

FSSM_MASK

Поиск по маске, начиная с текущего каталога.

FSSM_LIST

Поиск по маске в списке каталогов.

Flags

Флаги, может быть комбинация из следующих значений:

FSSF_PROCESSSUBDIR

Если этот флаг указан, то проводится обработка подкаталогов, если таковые попадутся. Поиск в подкаталогах осуществляется по маске не зависимо от searchmode.

FSSF_PROCESSDIR

Если этот флаг указан, то функции-обработчику будут передаваться помимо файлов так же и каталоги.

FSSF_ONLYDIR

Если этот флаг указан, то функции-обработчику будут передаваться только каталоги. Имеет смысл использовать этот флаг только совместно с FSSF_PROCESSDIR.

FSSF_SILENT

Не выдавать сообщений о неправильных параметрах. Если этот флаг не указан, то будут выдаваться сообщения (стандартного фаровского вида) о некорректных параметрах, переданных в FS_Set. Используйте этот флаг, если вы уверены, что все параметры правильные или хотите сами выдавать соответствующие сообщения на основании кода возврата из этой функции.

eso

Дополнительные параметры поиска. Может быть NULL.

root

Каталог для начала поиска (если searchmode равно 1) или список каталогов через точку с запятой или через запятую (если searchmode равно 2). Может быть NULL только, если searchmode равно 0.

mask

Указатель на строку с масками файлов, оформленными по правилам S&R.

panelInfo

Указатель на структуру PanelInfo (см. документацию FAR), она должна быть заполненной до вызова FS_Set. Не может быть NULL.

srws

Указатель на структуру SRWORKSTATUS. Поле ExitCode этой структуры при вызове FS_Set приудительно будет приравнено SRWE_OK или соответствующему ситуации коду ошибки.

Reserved

Зарезервировано для будущего использования. Должно быть 0.

Возвращаемое значение

Возвращается код ошибки (FS_ERROR_CODE). Может быть одним из следующих:

FSE_SUCCESS

Ошибок не было, можно смело использовать FS_Search.

FSE_FILEMASK

Некорректная маска файлов.

FSE_NEEDREALFILEPANEL

Для выполнения задания требуется обычная файловая панель.

FSE_DIRLIST

Некорректный список каталогов.