Связанные файлы вызов сервера ДО

СвязанныеФайлыПоВладельцу

Описание, пример вызова

// Возвращает массив структур, описывающих файлы владельца независимо от места хранения
//
// Параметры:
//   Владелец - ЛюбаяСсылка - объект-владелец связанных файлов
//   ДокументID - идентификатор связанного объекта ДО (если не передан, будет определен автоматически)
//   ДокументТип - тип связанного объекта ДО (если не передан, будет определен автоматически)
//   ВключатьПомеченныеНаУдаление - Булево - Истина, если требуется получить и помеченные на удаление.
//
// Возвращаемое значение:
//   Массив - структуры, описывающие реквизиты связанных файлов
//
Функция СвязанныеФайлыПоВладельцу(Владелец, ДокументID = "", ДокументТип = "", Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.СвязанныеФайлыПоВладельцу(Владелец, ДокументID, ДокументТип, );

ПолучитьФайлПоИдентификатору

Описание, пример вызова

// Возвращает структуру, описывающую файл, найденный по идентификатору 1С:Документооборот.
//
// Параметры:
//   ИдентификаторФайла - идентификатор связанного объекта ДО.
//
// Возвращаемое значение:
//  Структура, описывающая реквизиты найденного файла, если файл найден.
//    Описание полей см. СвязанныеФайлыВызовСервера.ПолучитьШаблонОписанияФайла().
//  Неопределено, если файл не найден.
//
Функция ПолучитьФайлПоИдентификатору(ИдентификаторФайла) Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ПолучитьФайлПоИдентификатору(ИдентификаторФайла)

ПолучитьФайлПоСсылке

Описание, пример вызова

// Возвращает структуру, описывающую файл, найденный по ссылке.
// Аналогична функции ПолучитьФайлПоИдентификатору.
//
Функция ПолучитьФайлПоСсылке(СсылкаНаФайл) Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ПолучитьФайлПоСсылке(СсылкаНаФайл)

ДобавитьФайлИзВременногоХранилища

Описание, пример вызова

// Возвращает файл, добавленный владельцу из временного хранилища и помещенный в ДО.
// Может приводить к автоматическому созданию связанного объекта.
//
// Параметры:
//   Владелец - ЛюбаяСсылка - объект-владелец связанных файлов
//   АдресВременногоХранилищаФайла - Строка - адрес временного хранилища, где размещен файл
//   Имя - Строка - имя помещаемого файла
//   Расширение - Строка - расширение помещаемого файла
//   Размер - Число - размер помещаемого файла
//   ВремяИзменения - Дата - дата и время файла на диске
//   ВремяИзмененияУниверсальное - Дата - дата и время UTC файла на диске
//   ДокументID - идентификатор связанного объекта ДО (если не передан, будет определен автоматически)
//   ДокументТип - тип связанного объекта ДО (если не передан, будет определен автоматически)
//
// Возвращаемое значение:
//   Строка - идентификатор файла ДО.
//
Функция ДобавитьФайлИзВременногоХранилища(Владелец, АдресВременногоХранилищаФайла, Имя, Расширение, Размер, Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ДобавитьФайлИзВременногоХранилища(Владелец, АдресВременногоХранилищаФайла, Имя, Расширение, Размер, );

ДобавитьФайлИзШаблона

Описание, пример вызова

// Возвращает файл, добавленный владельцу копированием шаблона и помещенный в ДО.
// Может приводить к автоматическому созданию связанного объекта.
//
// Параметры:
//   Владелец - ЛюбаяСсылка - объект-владелец связанных файлов или папка при хранении в этой ИБ
//   Шаблон - СправочникСсылка.Файлы - шаблон для копирования
//   ДокументID - идентификатор связанного объекта ДО (если не передан, будет определен автоматически)
//   ДокументТип - тип связанного объекта ДО (если не передан, будет определен автоматически)
//
// Возвращаемое значение:
//   Строка - идентификатор файла ДО.
//
Функция ДобавитьФайлИзШаблона(Владелец, Шаблон, ДокументID = "", ДокументТип = "") Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ДобавитьФайлИзШаблона(Владелец, Шаблон, ДокументID, ДокументТип);

ОбновитьФайлИзВременногоХранилища

Описание, пример вызова

// Обновить файл, добавленный владельцу из временного хранилища и помещенный в ДО.
// Может приводить к автоматическому созданию связанного объекта.
//
// Параметры:
//   Владелец - ЛюбаяСсылка - объект-владелец связанных файлов
//   АдресВременногоХранилищаФайла - Строка - адрес временного хранилища, где размещен файл
//   Имя - Строка - имя помещаемого файла
//   Расширение - Строка - расширение помещаемого файла
//   Размер - Число - размер помещаемого файла
//   ВремяИзменения - Дата - дата и время файла на диске
//   ВремяИзмененияУниверсальное - Дата - дата и время UTC файла на диске
//   ДокументID - идентификатор связанного объекта ДО (если не передан, будет определен автоматически)
//   ДокументТип - тип связанного объекта ДО (если не передан, будет определен автоматически)
//
// Возвращаемое значение:
//   Булево - Истина, если файл обновлен успешно.
//
Функция ОбновитьФайлИзВременногоХранилища(ИдентификаторФайла, Владелец, Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ОбновитьФайлИзВременногоХранилища(ИдентификаторФайла, Владелец, );

ВерсииФайла

Описание, пример вызова

// Возвращает массив структур, описывающих версии файла.
//
// Параметры:
//   ИдентификаторФайла - Строка - идентификатор файла в ДО
//   ВключатьПомеченныеНаУдаление - Булево - Истина, если требуется
//    получить и помеченные на удаление.
//
// Возвращаемое значение:
//   Массив - структуры, описывающие реквизиты версий файла
//
Функция ВерсииФайла(ИдентификаторФайла, ВключатьПомеченныеНаУдаление = Ложь) Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ВерсииФайла(ИдентификаторФайла, ВключатьПомеченныеНаУдаление);

ПометитьНаУдалениеСнятьПометку

Описание, пример вызова

// Помечает на удаление или снимает пометку с указанного файла.
//
// Параметры:
//   ИдентификаторФайла - Строка - идентификатор файла в ДО.
//
Процедура ПометитьНаУдалениеСнятьПометку(ИдентификаторФайла) Экспорт

Пример вызова

СвязанныеФайлыВызовСервераДО.ПометитьНаУдалениеСнятьПометку(ИдентификаторФайла)

ПометитьНаУдалениеПоВладельцу

Описание, пример вызова

// Изменить пометку на удаление для файлов принадлежащих Владелец
//
// Параметры:
//  ПометкаНаУдаление - Булево, Истина - установить, Ложь - снять пометку на удаление.
//  Владелец - ЛюбаяСсылка - объект-владелец связанных файлов.
//  ДокументID - идентификатор связанного объекта ДО (если не передан, будет определен автоматически).
//  ДокументТип - тип связанного объекта ДО (если не передан, будет определен автоматически).
//
Процедура ПометитьНаУдалениеПоВладельцу(ПометкаНаУдаление, Владелец, ДокументID = "", ДокументТип = "") Экспорт

Пример вызова

СвязанныеФайлыВызовСервераДО.ПометитьНаУдалениеПоВладельцу(ПометкаНаУдаление, Владелец, ДокументID, ДокументТип);

ПолучитьСсылкуНаФайл

Описание, пример вызова

// Получить ссылку на файл по его идентификатору. Возвращает переданный идентификатор.
// Необходима для унифицированной обработки идентификатора файла, с целью последующей передачи в другие функции.
// В рамках данного модуля можно не использовать.
//
// Параметры:
//   ИдентификаторФайла - Строка - идентификатор файла в ДО.
//
// Возвращает:
//  Строка, возвращает переданный идентификатор файла.
//
Функция ПолучитьСсылкуНаФайл(ИдентификаторФайла) Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ПолучитьСсылкуНаФайл(ИдентификаторФайла)

ПолучитьИдентификаторФайлаПоСсылке

Описание, пример вызова

// Получить идентификатор файла в 1С:Документооборот.
// Вспомогательная функция для унификации идентификатора файла.
//
// Параметры:
//  СсылкаНаФайл - Строка - обобщенная ссылка на файл, помещеенный в базу.
//
// Возвращает:
//  Строка - идентификатор в 1С:Документооборот.
//
Функция ПолучитьИдентификаторФайлаПоСсылке(СсылкаНаФайл) Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ПолучитьИдентификаторФайлаПоСсылке(СсылкаНаФайл)

ПолучитьДанныеФайлаДляОткрытия

Описание, пример вызова

// Получить данные для открытия функцией СвязанныеФайлыКлиент.ОткрытьФайлДляПросмотра(ДанныеФайла)
//
Функция ПолучитьДанныеФайлаДляОткрытия(ИдентификаторФайла, УникальныйИдентификаторФормы) Экспорт

Пример вызова

Результат = СвязанныеФайлыВызовСервераДО.ПолучитьДанныеФайлаДляОткрытия(ИдентификаторФайла, УникальныйИдентификаторФормы)