Приложения

Приложение А. Функции, константы и структуры RDS

А.5. Сервисные функции и макросы RDS

А.5.2. Управление работой RDS и функции общего назначения

А.5.2.19. rdsFileExists – проверка существования файла

Функция rdsFileExists проверяет существование файла, полный или сокращенный путь к которому передан в ее параметре.

  BOOL RDSCALL rdsFileExistsA(
    RDSCSTR FileName,      // Имя файла, возможно, с путем (UTF8)
    RDSCSTR AltDefPath,    // Путь по умолчанию или NULL (UTF8)
    RDSCSTR *pReturnPath,  // Формируемая строка полного пути (UTF8)
    int *pLength           // Возвращаемая длина строки
  );
  BOOL RDSCALL rdsFileExistsW(
    RDSWCSTR FileName,     // Имя файла, возможно, с путем (UTF16)
    RDSWCSTR AltDefPath,   // Путь по умолчанию или NULL (UTF16)
    RDSWCSTR *pReturnPath, // Формируемая строка полного пути (UTF16)
    int *pLength           // Возвращаемая длина строки
  );
  // Функция-псевдоним
  BOOL RDSCALL rdsFileExists(
    RDSXCSTR FileName,     // Имя файла, возможно, с путем (кодировка по умолчанию)
    RDSXCSTR AltDefPath,   // Путь по умолчанию или NULL (кодировка по умолчанию)
    RDSXCSTR *pReturnPath, // Формируемая строка полного пути (кодировка по умолчанию)
    int *pLength           // Возвращаемая длина строки
  );

Тип указателя на эту функцию

RDS_BSSpSpI (для UTF8) или RDS_BWsWspWspI (для UTF16)

Параметры

FileName (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с полным или сокращенным путем к файлу. В сокращенном пути могут использоваться специальные символические константы RDS.
AltDefPath (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку, которая добавляется к строке FileName, если последняя не содержит ни стандартных символических констант, ни полного пути. Если этот параметр равен NULL, к FileName будет добавлен путь к папке, в которой находится файл загруженной в данный момент схемы.
pReturnPath (RDSSTR*, RDSWSTR*, RDSXSTR*): Указатель на переменную, в которую будет записан указатель на сформированную динамическую строку с полным путем к файлу. Эту строку необходимо будет освободить при помощи rdsFree. Если в параметре pReturnPath передано значение NULL, строка с полным путем не формируется.
pLength (int*): Указатель на целую переменную, в которую функция запишет длину сформированной строки с полным путем к файлу. Если вызвавшей программе не нужно это значение, в pLength можно передать NULL.

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

TRUE, если файл с указанным именем существует, и FALSE в противном случае.

Пример

Пример использования функции rdsFileExists приведен в §3.5 руководства программиста.

См. также

Сервисные функции со строковыми параметрами и результатом, rdsGetFullFilePath, rdsGetRelFilePath, rdsFree.