СоединениеSftp

Стд::Ssh::СоединениеSftp

Представляет интерфейс для взаимодействия с сервером про протоколу SFTP. Возвращается методом ОткрытьСоединениеSftp.

Сравнение ссылочное

Иерархия типа

Базовые типы: Закрываемое, Объект

---

Примеры

метод ЗагрузитьФайл(Файл: Файл)
    исп Соединение = новый СоединениеSsh("192.168.0.3", "user", "password")
    исп Фтп = Соединение.ОткрытьСоединениеSftp()
    Фтп.УстановитьТекущийКаталог("/tmp/")
    Фтп.Поместить(Файл)
;

---

Свойства

СоединениеSsh

ТолькоЧтение

СоединениеSsh: СоединениеSsh

Соединение SSH, на основе которого работает данное соединение SFTP. При закрытии соединения SSH-соединения данное SFTP-соединение также будет закрыто.

---

ТекущийКаталог

ТолькоЧтение

ТекущийКаталог: Строка

Текущая директория на сервере. При открытии соединения свойство заполняется директорией по умолчанию. Команда SFTP: pwd.

---

Методы

ВСтроку

ВСтроку(): Строка

Переопределение: ВСтроку

Возвращает строковое представление в виде SFTP Connection: "%Пользователь@%Сервер:%Порт"

---

Закрыть

Закрыть()

Переопределение: Закрыть

Закрывает соединение. Повторное закрытие не выполняет никаких действий. После закрытия соединения все остальные методы будут выбрасывать ИсключениеSftp.

---

Переименовать

Переименовать(
Путь: Строка,
НовоеИмя: Строка,
Таймаут: Длительность? = Неопределено)

Переименовывает файл или директорию по пути Путь на сервере в новое имя НовоеИмя. Путь абсолютный (начинается с "/") или относительный текущему каталогу на сервере. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Переместить

Переместить(
СтарыйПуть: Строка,
НовыйПуть: Строка,
Таймаут: Длительность? = Неопределено)

Перемещает файл или директорию на сервере по пути СтарыйПуть в новый путь НовыйПуть. Пути абсолютные (начинается с "/") или относительные текущему каталогу на сервере. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Получить

Получить(
Путь: Строка,
Файл: Файл|Строка,
Таймаут: Длительность? = Неопределено)

Перегрузка:
Получить(Путь: Строка, Поток: ПотокЗаписи, Таймаут: Длительность? = Неопределено)

Скачивает файл по пути Путь на сервере на локальный диск по пути Файл. Путь - абсолютный (начинается с "/") или относительный текущему каталогу путь на сервере. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Получить

Получить(
Путь: Строка,
Поток: ПотокЗаписи,
Таймаут: Длительность? = Неопределено)

Перегрузка:
Получить(Путь: Строка, Файл: Файл|Строка, Таймаут: Длительность? = Неопределено)

Скачивает файл по пути Путь на сервере и записывает содержимое в поток Поток. Путь - абсолютный (начинается с "/") или относительный текущему каталогу путь на сервере. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

ПолучитьСписокФайлов

ПолучитьСписокФайлов(Таймаут: Длительность? = Неопределено): ЧитаемыйМассив<ФайлSftp>

Перегрузка:
ПолучитьСписокФайлов(Путь: Строка, Таймаут: Длительность? = Неопределено): ЧитаемыйМассив<ФайлSftp>

Возвращает список файлов и директорий в текущем каталоге. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

ПолучитьСписокФайлов

ПолучитьСписокФайлов(
Путь: Строка,
Таймаут: Длительность? = Неопределено
): ЧитаемыйМассив<ФайлSftp>

Перегрузка:
ПолучитьСписокФайлов(Таймаут: Длительность? = Неопределено): ЧитаемыйМассив<ФайлSftp>

Возвращает список файлов и директорий в директории по пути Путь. Путь - абсолютный (начинается с "/") или относительный текущему каталогу путь на сервере. Может содержать шаблон имени с символами * и ? (например "*.txt"), в этом случае метод вернет только список файлов и директорий, имя которых соответствует шаблону). Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Поместить

Поместить(
Файл: Файл|Строка,
Таймаут: Длительность? = Неопределено)

Перегрузка:
Поместить(Файл: Файл|Строка, Путь: Строка, Таймаут: Длительность? = Неопределено)
Поместить(Поток: ПотокЧтения, Путь: Строка, Таймаут: Длительность? = Неопределено)

Загружает файл Файл на сервер в текущий каталог. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Поместить

Поместить(
Файл: Файл|Строка,
Путь: Строка,
Таймаут: Длительность? = Неопределено)

Перегрузка:
Поместить(Файл: Файл|Строка, Таймаут: Длительность? = Неопределено)
Поместить(Поток: ПотокЧтения, Путь: Строка, Таймаут: Длительность? = Неопределено)

Загружает файл Файл на сервер по пути Путь. Путь абсолютный (начинается с "/") или относительный текущему каталогу на сервере. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Поместить

Поместить(
Поток: ПотокЧтения,
Путь: Строка,
Таймаут: Длительность? = Неопределено)

Перегрузка:
Поместить(Файл: Файл|Строка, Таймаут: Длительность? = Неопределено)
Поместить(Файл: Файл|Строка, Путь: Строка, Таймаут: Длительность? = Неопределено)

Загружает файл из потока Поток на сервер по пути Путь. Путь абсолютный (начинается с "/") или относительный текущему каталогу на сервере. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

СоздатьКаталог

СоздатьКаталог(
Путь: Строка,
Таймаут: Длительность? = Неопределено)

Создает директорию на сервере. Путь - абсолютный (начинается с "/") или относительный текущему каталогу путь к директории, которую надо создать. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Удалить

Удалить(
Путь: Строка,
Таймаут: Длительность? = Неопределено)

Удаляет файл по указанному пути с сервера. Путь - абсолютный (начинается с "/") или относительный текущему каталогу путь на сервере. Для удаления каталога необходимо использовать метод УдалитьКаталог. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

УдалитьКаталог

УдалитьКаталог(
Путь: Строка,
Таймаут: Длительность? = Неопределено)

Удаляет каталог по указанному пути с сервера. Путь - абсолютный (начинается с "/") или относительный текущему каталогу путь на сервере. Для удаления каталога необходимо использовать метод УдалитьКаталог. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

УстановитьТекущийКаталог

УстановитьТекущийКаталог(
Путь: Строка,
Таймаут: Длительность? = Неопределено)

Устанавливает текущим каталог Путь на сервере. Путь абсолютный (начинается с "/") или относительный текущему каталогу на сервере. Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеSftp - в случае ошибки взаимодействия с сервером или по истечении таймаута. ИсключениеФайловойСистемыSftp - в случае ошибки файловой системы на стороне сервера.

---

Список унаследованных методов

Объект

ПолучитьТип, Представление