Приложения

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

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

А.5.20. Работа с временными файлами

А.5.20.6. rdsTMPRememberFileName – запомнить файл как временный

Функция rdsTMPRememberFileName добавляет к набору временных файлов новое имя.

  RDSSTR RDSCALL rdsTMPRememberFileNameA( // UTF8
    int SetId,        // Набор временных файлов
    RDSCSTR FullName  // Полное имя (с путем, UTF8)
  );
  RDSWSTR RDSCALL rdsTMPRememberFileNameW( // UTF16
    int SetId,        // Набор временных файлов
    RDSWCSTR FullName // Полное имя (с путем, UTF16)
  );
  // Функция-псевдоним
  RDSXSTR RDSCALL rdsTMPRememberFileName( // Кодировка по умолчанию
    int SetId,        // Набор временных файлов
    RDSXCSTR FullName // Полное имя (с путем, кодировка по умолчанию)
  );

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

RDS_SIS (для UTF8) или RDS_WsIWs (для UTF16)

Параметры

SetId (int)

Уникальный целый идентификатор набора временных файлов, к которому будет принадлежать этот файл.

FullName (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с именем файла. Имя должно содержать путь к файлу (возможно использование символических обозначений путей).

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

Указатель на строку во внутренней памяти RDS, содержащую полное (с путем) имя временного файла.

Примечания

Эта функция добавляет в набор SetId новое имя временного файла FullName. Сам файл не создается – независимо от того, существует он в данный момент или нет, имя FullName (с преобразованием символических обозначений путей к стандартным папкам в сами пути, если эти обозначения там встретятся) будет добавлено в набор, и файл с таким именем будет удален при вызове rdsTMPDeleteFileSet. Функция rdsTMPRememberFileName может быть полезна в тех случаях, когда временные файлы создаются какой-либо другой программой (например, компилятором), но их имена заранее известны.

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

См. также

rdsTMPCreateFileSet, rdsTMPDeleteFileSet, rdsTMPCreateEmptyFile, rdsTMPCreateEmptyFileAnyExt.