Общего назначения

СообщитьПользователю

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

// Формирует и выводит сообщение, которое может быть связано с элементом управления формы.
//
// В фоновом задании длительной операции, если вызов выполнен вне транзакции,
// сообщение записывается в служебный регистр и отправляется сразу на клиент,
// если подключена система взаимодействия.
// В конце фонового задания длительной операции, а также при отправке прогресса,
// все сообщения извлекаются из очереди сообщений фонового задания,
// записываются в служебный регистр и отправляются сразу на клиент,
// если подключена система взаимодействия.
//
// АПК:142-выкл 4 необязательных параметра для совместимости
// с устаревшей процедурой ОбщегоНазначенияКлиентСервер.СообщитьПользователю.
//
// Параметры:
//  ТекстСообщенияПользователю - Строка - текст сообщения.
//  КлючДанных - Произвольный - объект, ссылка или ключ записи информационной базы, к которому это сообщение относится.
//  Поле - Строка - наименование реквизита формы.
//  ПутьКДанным - Строка - путь к данным (путь к реквизиту формы).
//  Отказ - Булево - выходной параметр, всегда устанавливается в значение Истина.
//
// Пример:
//
//  1. Для вывода сообщения у поля управляемой формы, связанного с реквизитом объекта:
//  ОбщегоНазначения.СообщитьПользователю(
//   НСтр("ru = 'Сообщение об ошибке.'"), ,
//   "ПолеВРеквизитеФормыОбъект",
//   "Объект");
//
//  Альтернативный вариант использования в форме объекта:
//  ОбщегоНазначения.СообщитьПользователю(
//   НСтр("ru = 'Сообщение об ошибке.'"), ,
//   "Объект.ПолеВРеквизитеФормыОбъект");
//
//  2. Для вывода сообщения рядом с полем управляемой формы, связанным с реквизитом формы:
//  ОбщегоНазначения.СообщитьПользователю(
//   НСтр("ru = 'Сообщение об ошибке.'"), ,
//   "ИмяРеквизитаФормы");
//
//  3. Для вывода сообщения связанного с объектом информационной базы:
//  ОбщегоНазначения.СообщитьПользователю(
//   НСтр("ru = 'Сообщение об ошибке.'"), ОбъектИнформационнойБазы, "Ответственный",,Отказ);
//
//  4. Для вывода сообщения по ссылке на объект информационной базы:
//  ОбщегоНазначения.СообщитьПользователю(
//   НСтр("ru = 'Сообщение об ошибке.'"), Ссылка, , , Отказ);
//
//  Случаи некорректного использования:
//   1. Передача одновременно параметров КлючДанных и ПутьКДанным.
//   2. Передача в параметре КлючДанных значения типа отличного от допустимого.
//   3. Установка ссылки без установки поля (и/или пути к данным).
//
Процедура СообщитьПользователю(Знач ТекстСообщенияПользователю, Знач КлючДанных = Неопределено,  Знач Поле = "", Экспорт

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

ОбщегоНазначения.СообщитьПользователю(ТекстСообщенияПользователю, КлючДанных, Поле, );

ЗначенияРеквизитовОбъекта

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

////////////////////////////////////////////////////////////////////////////////
// Общие процедуры и функции для работы с данными в базе.

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

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

Результат = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(Ссылка, Реквизиты, ВыбратьРазрешенные, КодЯзыка);

ЗначениеРеквизитаОбъекта

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

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

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

Результат = ОбщегоНазначения.ЗначениеРеквизитаОбъекта(Ссылка, ИмяРеквизита, ВыбратьРазрешенные, КодЯзыка);

ЗначенияРеквизитовОбъектов

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

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

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

Результат = ОбщегоНазначения.ЗначенияРеквизитовОбъектов(Ссылки, Реквизиты, ВыбратьРазрешенные, КодЯзыка);

ЗначениеРеквизитаОбъектов

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

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

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

Результат = ОбщегоНазначения.ЗначениеРеквизитаОбъектов(МассивСсылок, ИмяРеквизита, ВыбратьРазрешенные, КодЯзыка);

УстановитьЗначениеРеквизита

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

// Добавляет или изменяет значение реквизита в объекте.
//
// Если передано имя несуществующего реквизита, то вызывается исключение.
//
// Параметры:
//  Объект - СправочникОбъект
//         - ДокументОбъект
//         - ПланВидовХарактеристикОбъект
//         - РегистрСведенийЗапись - заполняемый объект.
//  ИмяРеквизита - Строка - имя заполняемого реквизита. Например, "Комментарий"
//  Значение - Строка - значение помещаемое в реквизит.
//  КодЯзыка - Строка - код языка реквизита. Например, "ru".
//
Процедура УстановитьЗначениеРеквизита(Объект, ИмяРеквизита, Значение, КодЯзыка = Неопределено) Экспорт

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

ОбщегоНазначения.УстановитьЗначениеРеквизита(Объект, ИмяРеквизита, Значение, КодЯзыка);

УстановитьЗначенияРеквизитов

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

// Добавляет или изменяет значения реквизитов в объекте.
//
// Если передано имя несуществующего реквизита, то вызывается исключение.
//
// Параметры:
//  Объект - СправочникОбъект
//         - ДокументОбъект
//         - ПланВидовХарактеристикОбъект
//         - РегистрСведенийЗапись - заполняемый объект.
//  Значения - Структура - где ключ это имя реквизита, а значение содержит строку помещаемую в реквизит.
//  КодЯзыка - Строка - код языка реквизита. Например, "ru".
//
Процедура УстановитьЗначенияРеквизитов(Объект, Значения, КодЯзыка = Неопределено) Экспорт

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

ОбщегоНазначения.УстановитьЗначенияРеквизитов(Объект, Значения, КодЯзыка);

КодОсновногоЯзыка

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

// Возвращает код основного языка информационной базы, например "ru".
// На котором программно записываются автогенерируемые строки в информационную базу.
// Например, при начальном заполнении информационной базы данными из макета, автогенерации комментария
// к проводке или определении значения параметра ИмяСобытия метода ЗаписьЖурналаРегистрации.
//
// Возвращаемое значение:
//  Строка
//
Функция КодОсновногоЯзыка() Экспорт

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

Результат = ОбщегоНазначения.КодОсновногоЯзыка()

ЭтоОсновнойЯзык

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

// Возвращает признак того, что для пользователя установлен язык интерфейса
// соответствующий основному языку информационной базы.
//
// Возвращаемое значение:
//  Булево
//
Функция ЭтоОсновнойЯзык() Экспорт

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

Результат = ОбщегоНазначения.ЭтоОсновнойЯзык()

ПредопределенныйЭлемент

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

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

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

Результат = ОбщегоНазначения.ПредопределенныйЭлемент(ПолноеИмяПредопределенного)

ЭтоПредопределенныеЭлементы

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

// Возвращает информацию о том, являются ли переданные элементы предопределенными.
// Если нет прав доступа на уровне записей, то элемент не включается в результат.
// Если нет прав доступа к таблице, то вызывается исключение.
//
// Параметры:
//  Элементы - Массив из ЛюбаяСсылка
//
// Возвращаемое значение:
//  Соответствие из КлючИЗначение - список объектов и значений их реквизитов:
//   * Ключ - ЛюбаяСсылка - ссылка на объект.
//   * Значение - Булево - Истина, если это ссылка на предопределенный элемент.
//
Функция ЭтоПредопределенныеЭлементы(Знач Элементы) Экспорт

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

Результат = ОбщегоНазначения.ЭтоПредопределенныеЭлементы(Элементы)

ПроверитьПроведенностьДокументов

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

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

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

Результат = ОбщегоНазначения.ПроверитьПроведенностьДокументов(Документы)

ПровестиДокументы

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

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

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

Результат = ОбщегоНазначения.ПровестиДокументы(Документы)

ЕстьСсылкиНаОбъект

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

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

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

Результат = ОбщегоНазначения.ЕстьСсылкиНаОбъект(СсылкаИлиМассивСсылок, ИскатьСредиСлужебныхОбъектов);

СлужебныеСвязиДанных

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

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

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

Результат = ОбщегоНазначения.СлужебныеСвязиДанных(МестаИспользования, ИсключенияПоискаСсылок);

ЭтоСлужебнаяСвязьДанных

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

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

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

Результат = ОбщегоНазначения.ЭтоСлужебнаяСвязьДанных(МестоИспользования, ИсключенияПоискаСсылок);

ЗаменитьСсылки

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

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

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

Результат = ОбщегоНазначения.ЗаменитьСсылки(ПарыЗамен, ПараметрыЗамены);

ПараметрыЗаменыСсылок

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

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

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

Результат = ОбщегоНазначения.ПараметрыЗаменыСсылок()

МестаИспользования

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

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

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

Результат = ОбщегоНазначения.МестаИспользования(НаборСсылок, АдресРезультата, ДополнительныеПараметры);

ПараметрыПоискаМестИспользования

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

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

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

Результат = ОбщегоНазначения.ПараметрыПоискаМестИспользования()

ИсключенияПоискаСсылок

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

// Возвращает исключения при поиске мест использования объектов.
//
// Возвращаемое значение:
//   Соответствие из КлючИЗначение - исключения поиска ссылок в разрезе объектов метаданных:
//       * Ключ - ОбъектМетаданных - объект метаданных, для которого применяются исключения.
//       * Значение - Строка
//                  - Массив из Строка - описание исключенных реквизитов.
//           Если "*", то исключены все реквизиты объекта метаданных.
//           Если массив строк, то содержит относительные имена исключенных реквизитов.
//
Функция ИсключенияПоискаСсылок() Экспорт

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

Результат = ОбщегоНазначения.ИсключенияПоискаСсылок()

ПодчиненныеОбъекты

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

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

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

Результат = ОбщегоНазначения.ПодчиненныеОбъекты()

СвязиПодчиненныхОбъектовПоТипам

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

// Возвращает связи подчиненных объектов с указанием типа поля связи.
//
// Возвращаемое значение:
//   ТаблицаЗначений:
//    * Ключ - Строка
//    * ТипРеквизита - Тип
//    * ИмяРеквизита - Строка
//    * Используется - Булево
//    * Метаданные - ОбъектМетаданных
//
Функция СвязиПодчиненныхОбъектовПоТипам() Экспорт

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

Результат = ОбщегоНазначения.СвязиПодчиненныхОбъектовПоТипам()

ПодсистемаСуществует

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

////////////////////////////////////////////////////////////////////////////////
// Процедуры и функции для вызова необязательных подсистем.

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

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

Результат = ОбщегоНазначения.ПодсистемаСуществует(ПолноеИмяПодсистемы)

ОбщийМодуль

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

// Возвращает ссылку на общий модуль или модуль менеджера по имени.
// Применяется для условного вызова процедуры или функции совместно с ОбщегоНазначения.ПодсистемаСуществует.
// См. также ОбщегоНазначенияКлиент.ОбщийМодуль для вызова клиентского кода.
//
// Параметры:
//  Имя - Строка - имя общего модуля или модуля менеджера, например "ОбновлениеКонфигурации",
//                 "Обработка.ПолнотекстовыйПоиск".
//
// Возвращаемое значение:
//   ОбщийМодуль
//   МодульМенеджераОбъекта
//
// Пример:
//  Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ОбновлениеКонфигурации") Тогда
//    МодульОбновлениеКонфигурации = ОбщегоНазначения.ОбщийМодуль("ОбновлениеКонфигурации");
//    МодульОбновлениеКонфигурации.<Имя процедуры>();
//  КонецЕсли;
//
//  Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ПолнотекстовыйПоиск") Тогда
//    МодульОбработкаПолнотекстовыйПоиск = ОбщегоНазначения.ОбщийМодуль("Обработка.ПолнотекстовыйПоиск");
//    МодульОбработкаПолнотекстовыйПоиск.<Имя процедуры>();
//  КонецЕсли;
//
Функция ОбщийМодуль(Имя) Экспорт

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

Результат = ОбщегоНазначения.ОбщийМодуль(Имя)

ЭтоWindowsКлиент

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

////////////////////////////////////////////////////////////////////////////////
// Функции описания текущего окружения клиентского приложения и операционной системы.

// Возвращает Истина, если клиентское приложение запущено под управлением ОС Windows.
//
// Возвращаемое значение:
//  Булево - если нет клиентского приложения, возвращается Ложь.
//
Функция ЭтоWindowsКлиент() Экспорт

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

Результат = ОбщегоНазначения.ЭтоWindowsКлиент()

ЭтоWindowsСервер

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

// Возвращает Истина, если текущий сеанс выполняется на сервере, работающем под управлением ОС Windows.
//
// Возвращаемое значение:
//  Булево - Истина, если сервер работает под управлением ОС Windows.
//
Функция ЭтоWindowsСервер() Экспорт

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

Результат = ОбщегоНазначения.ЭтоWindowsСервер()

ЭтоLinuxКлиент

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

// Возвращает Истина, если клиентское приложение запущено под управлением ОС Linux.
//
// Возвращаемое значение:
//  Булево - если нет клиентского приложения, возвращается Ложь.
//
Функция ЭтоLinuxКлиент() Экспорт

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

Результат = ОбщегоНазначения.ЭтоLinuxКлиент()

ЭтоLinuxСервер

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

// Возвращает Истина, если текущий сеанс выполняется на сервере, работающем под управлением ОС Linux.
//
// Возвращаемое значение:
//  Булево - Истина, если сервер работает под управлением ОС Linux.
//
Функция ЭтоLinuxСервер() Экспорт

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

Результат = ОбщегоНазначения.ЭтоLinuxСервер()

ЭтоMacOSКлиент

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

// Возвращает Истина, если клиентское приложение запущено под управлением macОС.
//
// Возвращаемое значение:
//  Булево - если нет клиентского приложения, возвращается Ложь.
//
Функция ЭтоMacOSКлиент() Экспорт

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

Результат = ОбщегоНазначения.ЭтоMacOSКлиент()

ЭтоВебКлиент

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

// Возвращает Истина, если клиентское приложение является Веб-клиентом.
//
// Возвращаемое значение:
//  Булево - если нет клиентского приложения, возвращается Ложь.
//
Функция ЭтоВебКлиент() Экспорт

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

Результат = ОбщегоНазначения.ЭтоВебКлиент()

ЭтоМобильныйКлиент

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

// Возвращает Истина, если клиентское приложение является мобильным клиентом.
//
// Возвращаемое значение:
//  Булево - если нет клиентского приложения, возвращается Ложь.
//
Функция ЭтоМобильныйКлиент() Экспорт

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

Результат = ОбщегоНазначения.ЭтоМобильныйКлиент()

КлиентПодключенЧерезВебСервер

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

// Возвращает Истина, если клиентское приложение подключено к базе через веб-сервер.
//
// Возвращаемое значение:
//  Булево - Истина, если подключен.
//
Функция КлиентПодключенЧерезВебСервер() Экспорт

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

Результат = ОбщегоНазначения.КлиентПодключенЧерезВебСервер()

СистемнаяИнформацияКлиента

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

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

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

Результат = ОбщегоНазначения.СистемнаяИнформацияКлиента()

ИспользуемыйКлиент

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

// Возвращает имя используемого клиента, а для веб-браузера название и версию, если есть.
// До первого серверного вызова с клиента вернет Неопределено.
//
// Возвращаемое значение:
//  Строка - варианты строк "ВебКлиент.<Название>[.<Версия>]", "ТонкийКлиент",
//           "ТолстыйКлиентУправляемоеПриложение", "ТолстыйКлиентОбычноеПриложение",
//           где <Название> - варианты строк "Chrome", "Firefox", "Safari", "IE", "Opera"
//           или "Другой", когда не определен (ни один из указанных), например "ВебКлиент.Chrome.109".
//  Неопределено - если нет клиентского приложения или информация запрашивается
//   до первого серверного вызова, например, при первом вызове события
//   платформы УстановкаПараметровСеанса в модуле сеанса.
//
Функция ИспользуемыйКлиент() Экспорт

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

Результат = ОбщегоНазначения.ИспользуемыйКлиент()

РежимОтладки

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

// Возвращает Истина, если включен режим отладки.
//
// Возвращаемое значение:
//  Булево - Истина, если включен режим отладки.
//
Функция РежимОтладки() Экспорт

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

Результат = ОбщегоНазначения.РежимОтладки()

ОперативнаяПамятьДоступнаяКлиентскомуПриложению

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

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

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

Результат = ОбщегоНазначения.ОперативнаяПамятьДоступнаяКлиентскомуПриложению()

ИнформационнаяБазаФайловая

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

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

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

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

ЭтоАвтономноеРабочееМесто

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

// Возвращает Истина, если эта информационная база подключена к 1С:Fresh.
//
// Возвращаемое значение:
//  Булево - признак автономного рабочего места.
//
Функция ЭтоАвтономноеРабочееМесто() Экспорт

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

Результат = ОбщегоНазначения.ЭтоАвтономноеРабочееМесто()

ЭтоРаспределеннаяИнформационнаяБаза

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

// Возвращает признак того, что информационная база является распределенной (РИБ).
//
// Возвращаемое значение:
//   Булево
//
Функция ЭтоРаспределеннаяИнформационнаяБаза() Экспорт

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

Результат = ОбщегоНазначения.ЭтоРаспределеннаяИнформационнаяБаза()

ЭтоПодчиненныйУзелРИБ

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

// Определяет, что эта информационная база является подчиненным узлом
// распределенной информационной базы (РИБ).
//
// Возвращаемое значение:
//  Булево - Истина, если эта информационная база является подчиненным узлом РИБ.
//
Функция ЭтоПодчиненныйУзелРИБ() Экспорт

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

Результат = ОбщегоНазначения.ЭтоПодчиненныйУзелРИБ()

ЭтоПодчиненныйУзелРИБСФильтром

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

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

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

Результат = ОбщегоНазначения.ЭтоПодчиненныйУзелРИБСФильтром()

ТребуетсяОбновлениеКонфигурацииПодчиненногоУзлаРИБ

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

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

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

Результат = ОбщегоНазначения.ТребуетсяОбновлениеКонфигурацииПодчиненногоУзлаРИБ()

РазделениеВключено

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

// Возвращает признак работы в режиме разделения данных по областям
// (технически это признак условного разделения).
//
// Возвращает Ложь, если конфигурация не может работать в режиме разделения данных
// (не содержит общих реквизитов, предназначенных для разделения данных).
//
// Возвращаемое значение:
//  Булево - Истина, если разделение включено,
//           Ложь, если разделение выключено или не поддерживается.
//
Функция РазделениеВключено() Экспорт

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

Результат = ОбщегоНазначения.РазделениеВключено()

ДоступноИспользованиеРазделенныхДанных

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

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

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

Результат = ОбщегоНазначения.ДоступноИспользованиеРазделенныхДанных()

АдресПубликацииИнформационнойБазыВИнтернете

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

// Возвращает адрес публикации информационной базы для формирования прямых ссылок на объекты ИБ
// для возможности перехода к ним пользователей, имеющих доступ к базе через публикацию в сети Интернет.
// Например, если такой адрес включить в электронное письмо, то из письма одним нажатием
// можно перейти к форме объекта в самой программе.
//
// Возвращаемое значение:
//   Строка - адрес информационной базы, как он задан в настройке "Адрес в Интернете" в панели администрирования
//            (хранится в константе АдресПубликацииИнформационнойБазыВИнтернете).
//            Например, "HTTP://1c.com/database".
//
// Пример:
//  ОбщегоНазначения.АдресПубликацииИнформационнойБазыВЛокальнойСети() + "/" + e1cib/app/Обработка.ВыгрузкаДанныхПроекта";
//  возвращает прямую ссылку для открытия обработки ВыгрузкаДанныхПроекта.
//
Функция АдресПубликацииИнформационнойБазыВИнтернете() Экспорт

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

Результат = ОбщегоНазначения.АдресПубликацииИнформационнойБазыВИнтернете()

АдресПубликацииИнформационнойБазыВЛокальнойСети

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

// Возвращает адрес публикации информационной базы для формирования прямых ссылок на объекты ИБ
// для возможности перехода к ним пользователей, имеющих доступ к базе через публикацию локальной сети.
// Например, если такой адрес включить в электронное письмо, то из письма за одно нажатие
// можно перейти к форме объекта в самой программе.
//
// При работе в приложении в Интернете возвращает значение функции АдресПубликацииИнформационнойБазыВИнтернете.
//
// Возвращаемое значение:
//   Строка - адрес информационной базы, как он задан в настройке "Локальный адрес" в панели администрирования
//            (хранится в константе АдресПубликацииИнформационнойБазыВЛокальнойСети).
//            Например, "HTTP://localserver/base".
//
// Пример:
//  ОбщегоНазначения.АдресПубликацииИнформационнойБазыВЛокальнойСети() + "/" + e1cib/app/Обработка.ВыгрузкаДанныхПроекта";
//  возвращает прямую ссылку для открытия обработки ВыгрузкаДанныхПроекта.
//
Функция АдресПубликацииИнформационнойБазыВЛокальнойСети() Экспорт

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

Результат = ОбщегоНазначения.АдресПубликацииИнформационнойБазыВЛокальнойСети()

АдресВходаВПрограмму

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

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

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

Результат = ОбщегоНазначения.АдресВходаВПрограмму(Пользователь, Пароль, ВидПубликацииИБ)

РедакцияКонфигурации

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

// Возвращает редакцию конфигурации.
// Редакцией принято называть две первые группы цифр полной версии конфигурации.
// Например, у версии "1.2.3.4" редакция "1.2".
//
// Возвращаемое значение:
//  Строка - номер редакции конфигурации.
//
Функция РедакцияКонфигурации() Экспорт

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

Результат = ОбщегоНазначения.РедакцияКонфигурации()

ОбщиеПараметрыБазовойФункциональности

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

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

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

Результат = ОбщегоНазначения.ОбщиеПараметрыБазовойФункциональности(ВернутьЗакешированноеЗначение);

ОписанияПодсистем

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

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

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

Результат = ОбщегоНазначения.ОписанияПодсистем()

ИдентификаторИнтернетПоддержкиКонфигурации

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

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

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

Результат = ОбщегоНазначения.ИдентификаторИнтернетПоддержкиКонфигурации()

ПредставлениеЛокальнойДатыСоСмещением

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

// Преобразует локальную дату к формату "YYYY-MM-DDThh:mm:ssTZD" согласно ISO 8601.
//
// Параметры:
//  ЛокальнаяДата - Дата - дата в часовом поясе сеанса.
//
// Возвращаемое значение:
//   Строка - представление даты.
//
Функция ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата) Экспорт

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

Результат = ОбщегоНазначения.ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата)

ИнтервалВремениСтрокой

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

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

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

Результат = ОбщегоНазначения.ИнтервалВремениСтрокой(ВремяНачала, ВремяОкончания);

УстановитьРабочуюДатуПользователя

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

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

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

ОбщегоНазначения.УстановитьРабочуюДатуПользователя(НоваяРабочаяДата, ИмяПользователя);

РабочаяДатаПользователя

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

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

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

Результат = ОбщегоНазначения.РабочаяДатаПользователя(ИмяПользователя);

ТекущаяДатаПользователя

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

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

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

Результат = ОбщегоНазначения.ТекущаяДатаПользователя(ИмяПользователя);

ИмяЗначенияПеречисления

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

////////////////////////////////////////////////////////////////////////////////
// Общие процедуры и функции для работы с прикладными типами и коллекциями значений.

// Возвращает строковое имя значения перечисления по его ссылке.
// Вызывает исключение, если передано несуществующее значение перечисления
// (например, удаленное в конфигурации или от отключенного расширения конфигурации).
//
// Параметры:
//  Значение - ПеречислениеСсылка - значение, для которого необходимо получить имя перечисления.
//
// Возвращаемое значение:
//  Строка
//
// Пример:
//   В результат будет помещено строковое значение "ФизическоеЛицо":
//   Результат = ОбщегоНазначения.ИмяЗначенияПеречисления(Перечисления.ЮридическоеФизическоеЛицо.ФизическоеЛицо);
//
Функция ИмяЗначенияПеречисления(Значение) Экспорт

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

Результат = ОбщегоНазначения.ИмяЗначенияПеречисления(Значение)

УдалитьНепроверяемыеРеквизитыИзМассива

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

// Процедура удаляет из массива МассивРеквизитов элементы, соответствующие именам
// реквизитов объекта из массива МассивНепроверяемыхРеквизитов.
// Для использования в обработчиках события ОбработкаПроверкиЗаполнения.
//
// Параметры:
//  МассивРеквизитов              - Массив - коллекция имен реквизитов объекта.
//  МассивНепроверяемыхРеквизитов - Массив - коллекция имен реквизитов объекта, не требующих проверки.
//
Процедура УдалитьНепроверяемыеРеквизитыИзМассива(МассивРеквизитов, МассивНепроверяемыхРеквизитов) Экспорт

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

ОбщегоНазначения.УдалитьНепроверяемыеРеквизитыИзМассива(МассивРеквизитов, МассивНепроверяемыхРеквизитов)

ТаблицаЗначенийВМассив

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

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

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

Результат = ОбщегоНазначения.ТаблицаЗначенийВМассив(ТаблицаЗначений)

СтрокаТаблицыЗначенийВСтруктуру

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

// Преобразует строку таблицы значений в структуру.
// Свойства структуры и их значения совпадают с колонками переданной строки.
//
// Параметры:
//  СтрокаТаблицыЗначений - СтрокаТаблицыЗначений
//
// Возвращаемое значение:
//  Структура - преобразованная строка таблицы значений.
//
Функция СтрокаТаблицыЗначенийВСтруктуру(СтрокаТаблицыЗначений) Экспорт

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

Результат = ОбщегоНазначения.СтрокаТаблицыЗначенийВСтруктуру(СтрокаТаблицыЗначений)

СтруктураПоМенеджеруЗаписи

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

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

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

Результат = ОбщегоНазначения.СтруктураПоМенеджеруЗаписи(МенеджерЗаписи, МетаданныеРегистра)

ВыгрузитьКолонку

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

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

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

Результат = ОбщегоНазначения.ВыгрузитьКолонку(КоллекцияСтрок, ИмяКолонки, ТолькоУникальныеЗначения);

ПрочитатьXMLВТаблицу

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

// Преобразует текст указанного формата XML в таблицу значений,
// при этом колонки таблицы формируются на основе описания в XML.
//
// Схема XML:
// <?xml version="1.0" encoding="utf-8"?>
//  <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="HTTP://www.w3.org/2001/XMLSchema">
//   <xs:element name="Items">
//    <xs:complexType>
//     <xs:sequence>
//      <xs:element maxOccurs="unbounded" name="Item">
//       <xs:complexType>
//        <xs:attribute name="Code" type="xs:integer" use="required" />
//        <xs:attribute name="Name" type="xs:string" use="required" />
//        <xs:attribute name="Socr" type="xs:string" use="required" />
//        <xs:attribute name="Index" type="xs:string" use="required" />
//       </xs:complexType>
//      </xs:element>
//     </xs:sequence>
//    <xs:attribute name="Description" type="xs:string" use="required" />
//    <xs:attribute name="Columns" type="xs:string" use="required" />
//   </xs:complexType>
//  </xs:element>
// </xs:schema>
//
// Параметры:
//  XML - Строка
//      - ЧтениеXML - текст в формате XML или ЧтениеXML.
//
// Возвращаемое значение:
//  Структура:
//   * ИмяТаблицы - Строка          - имя таблицы.
//   * Данные     - ТаблицаЗначений - преобразованная из XML таблица.
//
// Пример:
//   КлассификаторТаблица = ОбщегоНазначения.ПрочитатьXMLВТаблицу(
//     Обработки.ЗагрузкаКурсовВалют.ПолучитьМакет("ОбщероссийскийКлассификаторВалют").ПолучитьТекст()).Данные;
//
Функция ПрочитатьXMLВТаблицу(Знач XML) Экспорт

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

Результат = ОбщегоНазначения.ПрочитатьXMLВТаблицу(XML)

КоллекцииИдентичны

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

// Сравнивает две коллекции строк (ТаблицаЗначений, ДеревоЗначений и т.д.),
// для которых доступен обход посредством оператора Для каждого … Из … Цикл.
// Сравниваемые коллекции должны отвечать следующим требованиям:
//  - доступен обход посредством оператора Для каждого … Из … Цикл,
//  - наличие в обеих коллекциях всех колонок, перечисленных в параметре ИменаКолонок
//  (если ИменаКолонок не заполнен - все колонки первой коллекции должны существовать во второй коллекции).
//  Также позволяет сравнивать массивы.
//  Для сравнения других коллекций, а также для сравнения коллекций с учетом вложенности см. функцию ДанныеСовпадают.
//
// Параметры:
//  КоллекцияСтрок1 - ТаблицаЗначений
//                  - ДеревоЗначений
//                  - СписокЗначений
//                  - ТабличнаяЧасть
//                  - Соответствие
//                  - Массив
//                  - ФиксированныйМассив
//                  - Структура - коллекция, отвечающая вышеописанным требованиям. А также другие
//                     объекты, для которых доступен обход посредством оператора Для каждого … Из … Цикл.
//  КоллекцияСтрок2 - ТаблицаЗначений
//                  - ДеревоЗначений
//                  - СписокЗначений
//                  - ТабличнаяЧасть
//                  - Соответствие
//                  - Массив
//                  - ФиксированныйМассив
//                  - Структура - коллекция, отвечающая вышеописанным требованиям. А также другие
//                     объекты, для которых доступен обход посредством оператора Для каждого … Из … Цикл.
//  ИменаКолонок - Строка - имена колонок через запятую, по которым производится сравнение.
//                          Не обязательно для коллекций, состав колонок которых можно определить автоматически:
//                          ТаблицаЗначений, СписокЗначений, Соответствие, Структура.
//                          Если не указан, то сравнение производится по колонкам первой коллекции.
//                          Для коллекций других типов является обязательным.
//                          Следует также учитывать, что при сравнении коллекций, содержащих вместо строк другие типы
//                          элементов, в качестве имен колонок можно указывать только имена свойств этих элементов.
//                          Для соответствий и структур это "Ключ" и "Значение", но не значения ключей.
//                          Для списков значений это "Значение" и "Представление", но не сами значения.
//
//  ИсключаяКолонки - Строка - имена колонок, которые игнорируются при сравнении.
//  УчитыватьПоследовательностьСтрок - Булево - если Истина, то коллекции признаются
//                      идентичными, только если одинаковые строки размещены в коллекциях на одинаковых местах.
//
// Возвращаемое значение:
//  Булево - Истина, если идентичны.
//
Функция КоллекцииИдентичны(КоллекцияСтрок1, КоллекцияСтрок2, Знач ИменаКолонок = "", Знач ИсключаяКолонки = "", Экспорт

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

Результат = ОбщегоНазначения.КоллекцииИдентичны(КоллекцияСтрок1, КоллекцияСтрок2, ИменаКолонок, ИсключаяКолонки, );

ДанныеСовпадают

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

// Сравнивает данные сложной структуры с учетом вложенности.
//
// Параметры:
//  Данные1 - Структура
//          - ФиксированнаяСтруктура
//          - Соответствие
//          - ФиксированноеСоответствие
//          - Массив
//          - ФиксированныйМассив
//          - ХранилищеЗначения
//          - ТаблицаЗначений
//          - Строка
//          - Число
//          - Булево - сравниваемые данные.
//  Данные2 - Произвольный - те же типы, что и для параметра Данные1.
//
// Возвращаемое значение:
//  Булево - Истина, если совпадают.
//
Функция ДанныеСовпадают(Данные1, Данные2) Экспорт

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

Результат = ОбщегоНазначения.ДанныеСовпадают(Данные1, Данные2)

ФиксированныеДанные

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

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

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

Результат = ОбщегоНазначения.ФиксированныеДанные(Данные, ВызыватьИсключение);

КонтрольнаяСуммаСтрокой

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

// Вычисляет контрольную сумму для произвольных данных по указанному алгоритму.
//
// Параметры:
//  Данные   - Произвольный - любое сериализуемое значение.
//  Алгоритм - ХешФункция   - алгоритм расчета контрольной суммы. По умолчанию, MD5.
//
// Возвращаемое значение:
//  Строка - контрольная сумма строкой без пробелов (например 32 символа).
//
Функция КонтрольнаяСуммаСтрокой(Знач Данные, Знач Алгоритм = Неопределено) Экспорт

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

Результат = ОбщегоНазначения.КонтрольнаяСуммаСтрокой(Данные, Алгоритм);

СократитьСтрокуКонтрольнойСуммой

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

// Сокращает строку до нужной длины, при этом обрезанная часть хешируется,
// обеспечивая уникальность строки. Проверяет длину строки на входе и, в случае
// превышения максимальной длины, преобразует ее конец по алгоритму MD5 в
// уникальную строку из 32 символов.
//
// Параметры:
//  Строка            - Строка - исходная строка произвольной длины.
//  МаксимальнаяДлина - Число  - требуемое максимальное количество символов в строке,
//                               минимальное значение: 32.
//
// Возвращаемое значение:
//   Строка - строка, не превышающая максимальную длину.
//
Функция СократитьСтрокуКонтрольнойСуммой(Строка, МаксимальнаяДлина) Экспорт

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

Результат = ОбщегоНазначения.СократитьСтрокуКонтрольнойСуммой(Строка, МаксимальнаяДлина)

СкопироватьРекурсивно

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

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

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

Результат = ОбщегоНазначения.СкопироватьРекурсивно(Источник, ФиксироватьДанные);

ПредметСтрокой

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

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

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

Результат = ОбщегоНазначения.ПредметСтрокой(СсылкаНаПредмет)

ПредметыСтрокой

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

// Возвращает описания предметов СсылкиНаПредметы.
// Для документов возвращается представление, для остальных ссылочных типов возвращается
// представление и тип в скобках, например, "Ножницы (Номенклатура)".
// Для пустых ссылок или незаполненных значений примитивных типов возвращается "не задан".
// Значение "удален", если объект не существует в информационной базе.
// Значения Неопределено пропускаются.
//
// Параметры:
//  СсылкиНаПредметы - Массив из ЛюбаяСсылка
//
// Возвращаемое значение:
//   Соответствие из КлючИЗначение:
//     * Ключ - ЛюбаяСсылка
//     * Значение - Строка - например, "Ножницы (Номенклатура)", "Заказ клиента № 0001 от 01.01.2001" или "не задан".
//
Функция ПредметыСтрокой(Знач СсылкиНаПредметы) Экспорт

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

Результат = ОбщегоНазначения.ПредметыСтрокой(СсылкиНаПредметы)

ПредставленияСсылок

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

// Возвращает представления переданных ссылок.
//
// Параметры:
//  ПроверяемыеСсылки - Массив из ЛюбаяСсылка, ЛюбаяСсылка
//
// Возвращаемое значение:
//  Соответствие из КлючИЗначение:
//   * Ключ - ЛюбаяСсылка
//   * Значение - Строка - представление ссылки или "удален", если ссылка не существует в информационной базе.
//
Функция ПредставленияСсылок(ПроверяемыеСсылки) Экспорт

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

Результат = ОбщегоНазначения.ПредставленияСсылок(ПроверяемыеСсылки)

СтруктураСвойствДинамическогоСписка

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

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

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

Результат = ОбщегоНазначения.СтруктураСвойствДинамическогоСписка()

УстановитьСвойстваДинамическогоСписка

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

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

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

ОбщегоНазначения.УстановитьСвойстваДинамическогоСписка(Список, СвойстваСписка)

ИдентификаторCOMСоединителя

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

////////////////////////////////////////////////////////////////////////////////
// Процедуры и функции для работы с внешним соединением.

// Возвращает CLSID COM-класса для работы с "1С:Предприятием 8" через COM-соединение.
//
// Параметры:
//  ИмяCOMСоединителя - Строка - имя COM-класса для работы с "1С:Предприятием 8" через COM-соединение.
//
// Возвращаемое значение:
//  Строка - строковое представление CLSID.
//
Функция ИдентификаторCOMСоединителя(Знач ИмяCOMСоединителя) Экспорт

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

Результат = ОбщегоНазначения.ИдентификаторCOMСоединителя(ИмяCOMСоединителя)

УстановитьВнешнееСоединениеСБазой

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

// Устанавливает внешнее соединение с информационной базой по переданным параметрам подключения и возвращает указатель
// на это соединение.
//
// Параметры:
//  Параметры - см. ОбщегоНазначенияКлиентСервер.СтруктураПараметровДляУстановкиВнешнегоСоединения
//
// Возвращаемое значение:
//  Структура:
//    * Соединение - COMОбъект
//                 - Неопределено - COM-объект соединения или Неопределено в случае ошибки;
//    * КраткоеОписаниеОшибки - Строка - краткое описание ошибки;
//    * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки;
//    * ОшибкаПодключенияКомпоненты - Булево - флаг ошибки подключения COM.
//
Функция УстановитьВнешнееСоединениеСБазой(Параметры) Экспорт

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

Результат = ОбщегоНазначения.УстановитьВнешнееСоединениеСБазой(Параметры)

ЭтоДокумент

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

// Ссылочные типы данных

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

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

Результат = ОбщегоНазначения.ЭтоДокумент(ОбъектМетаданных)

ЭтоСправочник

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

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

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

Результат = ОбщегоНазначения.ЭтоСправочник(ОбъектМетаданных)

ЭтоПеречисление

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

// Определяет принадлежность объекта метаданных к общему типу "Перечисление".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является перечислением.
//
Функция ЭтоПеречисление(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоПеречисление(ОбъектМетаданных)

ЭтоПланОбмена

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

// Определяет принадлежность объекта метаданных к общему типу "План обмена".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является планом обмена.
//
Функция ЭтоПланОбмена(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоПланОбмена(ОбъектМетаданных)

ЭтоПланВидовХарактеристик

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

// Определяет принадлежность объекта метаданных к общему типу "План видов характеристик".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является планом видов характеристик.
//
Функция ЭтоПланВидовХарактеристик(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоПланВидовХарактеристик(ОбъектМетаданных)

ЭтоБизнесПроцесс

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

// Определяет принадлежность объекта метаданных к общему типу "Бизнес-процесс".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является бизнес-процессом.
//
Функция ЭтоБизнесПроцесс(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоБизнесПроцесс(ОбъектМетаданных)

ЭтоЗадача

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

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

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

Результат = ОбщегоНазначения.ЭтоЗадача(ОбъектМетаданных)

ЭтоПланСчетов

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

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

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

Результат = ОбщегоНазначения.ЭтоПланСчетов(ОбъектМетаданных)

ЭтоПланВидовРасчета

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

// Определяет принадлежность объекта метаданных к общему типу "План видов расчета".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является планом видов расчета.
//
Функция ЭтоПланВидовРасчета(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоПланВидовРасчета(ОбъектМетаданных)

ЭтоРегистрСведений

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

// Регистры

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

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

Результат = ОбщегоНазначения.ЭтоРегистрСведений(ОбъектМетаданных)

ЭтоРегистрНакопления

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

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

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

Результат = ОбщегоНазначения.ЭтоРегистрНакопления(ОбъектМетаданных)

ЭтоРегистрБухгалтерии

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

// Определяет принадлежность объекта метаданных к общему типу "Регистр бухгалтерии".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является регистром бухгалтерии.
//
Функция ЭтоРегистрБухгалтерии(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоРегистрБухгалтерии(ОбъектМетаданных)

ЭтоРегистрРасчета

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

// Определяет принадлежность объекта метаданных к общему типу "Регистр расчета".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является регистром расчета.
//
Функция ЭтоРегистрРасчета(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоРегистрРасчета(ОбъектМетаданных)

ЭтоКонстанта

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

// Константы

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

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

Результат = ОбщегоНазначения.ЭтоКонстанта(ОбъектМетаданных)

ЭтоЖурналДокументов

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

// Журналы документов

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

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

Результат = ОбщегоНазначения.ЭтоЖурналДокументов(ОбъектМетаданных)

ЭтоПоследовательность

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

// Последовательности

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

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

Результат = ОбщегоНазначения.ЭтоПоследовательность(ОбъектМетаданных)

ЭтоРегламентноеЗадание

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

// РегламентныеЗадания

// Определяет принадлежность объекта метаданных к общему типу "Регламентные задания".
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является регламентным заданием.
//
Функция ЭтоРегламентноеЗадание(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоРегламентноеЗадание(ОбъектМетаданных)

ЭтоРегистр

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

// Общие

// Определяет принадлежность объекта метаданных к типу регистр.
//
// Параметры:
//  ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу.
//
// Возвращаемое значение:
//   Булево - Истина, если объект является каким-либо регистром.
//
Функция ЭтоРегистр(ОбъектМетаданных) Экспорт

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

Результат = ОбщегоНазначения.ЭтоРегистр(ОбъектМетаданных)

ЭтоОбъектСсылочногоТипа

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

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

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

Результат = ОбщегоНазначения.ЭтоОбъектСсылочногоТипа(ОбъектМетаданных)

ИменаРеквизитовПоТипу

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

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

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

Результат = ОбщегоНазначения.ИменаРеквизитовПоТипу(Ссылка, Тип)

ИмяБазовогоТипаПоОбъектуМетаданных

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

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

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

Результат = ОбщегоНазначения.ИмяБазовогоТипаПоОбъектуМетаданных(ОбъектМетаданных)

МенеджерОбъектаПоПолномуИмени

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

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

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

Результат = ОбщегоНазначения.МенеджерОбъектаПоПолномуИмени(ПолноеИмя)

МенеджерОбъектаПоСсылке

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

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

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

Результат = ОбщегоНазначения.МенеджерОбъектаПоСсылке(Ссылка)

ЭтоСсылка

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

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

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

Результат = ОбщегоНазначения.ЭтоСсылка(ПроверяемыйТип)

СсылкаСуществует

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

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

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

Результат = ОбщегоНазначения.СсылкаСуществует(ПроверяемаяСсылка)

ВидОбъектаПоСсылке

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

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

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

Результат = ОбщегоНазначения.ВидОбъектаПоСсылке(Ссылка)

ВидОбъектаПоТипу

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

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

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

Результат = ОбщегоНазначения.ВидОбъектаПоТипу(ТипОбъекта)

ИмяТаблицыПоСсылке

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

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

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

Результат = ОбщегоНазначения.ИмяТаблицыПоСсылке(Ссылка)

ЗначениеСсылочногоТипа

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

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

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

Результат = ОбщегоНазначения.ЗначениеСсылочногоТипа(Значение)

ОбъектЯвляетсяГруппой

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

// Проверяет, является ли элемент справочника или плана видов характеристик группой элементов.
//
// Параметры:
//  Объект - СправочникСсылка
//         - ПланВидовХарактеристикСсылка
//         - СправочникОбъект
//         - ПланВидовХарактеристикОбъект - проверяемый объект.
//
// Возвращаемое значение:
//  Булево
//
Функция ОбъектЯвляетсяГруппой(Объект) Экспорт

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

Результат = ОбщегоНазначения.ОбъектЯвляетсяГруппой(Объект)

ИдентификаторОбъектаМетаданных

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

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

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

Результат = ОбщегоНазначения.ИдентификаторОбъектаМетаданных(ОписаниеОбъектаМетаданных, ВызыватьИсключение);

ИдентификаторыОбъектовМетаданных

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

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

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

Результат = ОбщегоНазначения.ИдентификаторыОбъектовМетаданных(ОписаниеОбъектовМетаданных, ВызыватьИсключение);

ОбъектМетаданныхПоИдентификатору

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

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

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

Результат = ОбщегоНазначения.ОбъектМетаданныхПоИдентификатору(Идентификатор, ВызыватьИсключение);

ОбъектыМетаданныхПоИдентификаторам

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

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

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

Результат = ОбщегоНазначения.ОбъектыМетаданныхПоИдентификаторам(Идентификаторы, ВызыватьИсключение);

ОбъектМетаданныхПоПолномуИмени

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

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

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

Результат = ОбщегоНазначения.ОбъектМетаданныхПоПолномуИмени(ПолноеИмя)

ОбъектМетаданныхДоступенПоФункциональнымОпциям

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

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

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

Результат = ОбщегоНазначения.ОбъектМетаданныхДоступенПоФункциональнымОпциям(ОбъектМетаданных)

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

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

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

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

ОбщегоНазначения.ДобавитьПереименование(Переименования, ВерсияИБ, СтароеПолноеИмя, НовоеПолноеИмя, );

СтроковоеПредставлениеТипа

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

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

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

Результат = ОбщегоНазначения.СтроковоеПредставлениеТипа(Тип)

ОписаниеСвойствОбъекта

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

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

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

Результат = ОбщегоНазначения.ОписаниеСвойствОбъекта(ОбъектМетаданных, Свойства)

ЭтоСтандартныйРеквизит

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

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

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

Результат = ОбщегоНазначения.ЭтоСтандартныйРеквизит(СтандартныеРеквизиты, ИмяРеквизита)

ЕстьРеквизитОбъекта

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

// Позволяет определить, есть ли среди реквизитов объекта реквизит с переданным именем.
//
// Параметры:
//  ИмяРеквизита - Строка - имя реквизита;
//  МетаданныеОбъекта - ОбъектМетаданных - объект, в котором требуется проверить наличие реквизита.
//
// Возвращаемое значение:
//  Булево - Истина, если есть.
//
Функция ЕстьРеквизитОбъекта(ИмяРеквизита, МетаданныеОбъекта) Экспорт

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

Результат = ОбщегоНазначения.ЕстьРеквизитОбъекта(ИмяРеквизита, МетаданныеОбъекта)

ОписаниеТипаСостоитИзТипа

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

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

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

Результат = ОбщегоНазначения.ОписаниеТипаСостоитИзТипа(ОписаниеТипа, ТипЗначения)

ОписаниеТипаСтрока

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

// Создает объект ОписаниеТипов, содержащий тип Строка.
//
// Параметры:
//  ДлинаСтроки - Число - длина строки.
//
// Возвращаемое значение:
//  ОписаниеТипов - описание типа Строка.
//
Функция ОписаниеТипаСтрока(ДлинаСтроки) Экспорт

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

Результат = ОбщегоНазначения.ОписаниеТипаСтрока(ДлинаСтроки)

ОписаниеТипаЧисло

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

// Создает объект ОписаниеТипов, содержащий тип Число.
//
// Параметры:
//  Разрядность - Число - общее количество разрядов числа (количество разрядов
//                        целой части плюс количество разрядов дробной части).
//  РазрядностьДробнойЧасти - Число - число разрядов дробной части.
//  ЗнакЧисла - ДопустимыйЗнак - допустимый знак числа.
//
// Возвращаемое значение:
//  ОписаниеТипов - описание типа Число.
//
Функция ОписаниеТипаЧисло(Разрядность, РазрядностьДробнойЧасти = 0, Знач ЗнакЧисла = Неопределено) Экспорт

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

Результат = ОбщегоНазначения.ОписаниеТипаЧисло(Разрядность, РазрядностьДробнойЧасти, ЗнакЧисла);

ОписаниеТипаДата

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

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

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

Результат = ОбщегоНазначения.ОписаниеТипаДата(ЧастиДаты)

ОписаниеТипаВсеСсылки

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

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

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

Результат = ОбщегоНазначения.ОписаниеТипаВсеСсылки()

ПредставлениеСписка

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

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

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

Результат = ОбщегоНазначения.ПредставлениеСписка(ОбъектМетаданных)

ПредставлениеОбъекта

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

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

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

Результат = ОбщегоНазначения.ПредставлениеОбъекта(ОбъектМетаданных)

ОтборЗаписейНабораИзБазыДанных

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

// Возвращает условие отбора и параметры запроса для выбора записей из базы данных
// по указанному набору записей с учетом режима замещения.
//
// Если Замещение равно Истина или РежимЗамещения.Замещение, тогда
// записи будут извлекаться из базы данных по настройке свойства Отбор,
// в противном случае по ключам строк записей в наборе записей.
//
// Параметры:
//  НаборЗаписей - РегистрСведенийНаборЗаписей
//               - РегистрНакопленияНаборЗаписей
//               - РегистрБухгалтерииНаборЗаписей
//               - РегистрРасчетаНаборЗаписей - набор записей, который используется
//                   для подготовки условия и параметров для запроса.
//               - Отбор - отбор набора записей (в этом случае Замещение считается Истина).
//
//  Замещение - РежимЗамещения, Булево - как передается в подписку на событие ПередЗаписью.
//            - Неопределено - получить и установить в этот параметр значение из свойства
//                Замещение структуры ДополнительныеСвойства указанного набора записей
//                (если свойства нет, тогда устанавливается Истина).
//
//  Запрос - Запрос - установить параметры в указанный запрос и заменить на возвращаемое
//             УсловиеЗапроса строку "&УсловиеОтбора" в тексте запроса, если есть.
//         - Неопределено
//
//  ДополнительныеПараметры - см. НовыеПараметрыОтбораЗаписейНабораИзБазыДанных
//
// Возвращаемое значение:
//  Структура:
//   * УсловиеЗапроса - Строка - условие для подстановки в текст запроса.
//   * ПараметрыЗапроса - Структура из КлючИЗначение:
//      ** Ключ     - Строка - имя поля отбора или ЗначенияПолейОтбораСтрок с указанным префиксом.
//      ** Значение - Произвольный - значение поля отбора или таблица значений.
//
// Пример:
//  Запрос = Новый Запрос;
//  Запрос.Текст =
//  "ВЫБРАТЬ РАЗЛИЧНЫЕ
//  |  ТекущаяТаблица.Пользователь КАК Пользователь,
//  |  ТекущаяТаблица.ПотребоватьСменуПароляПриВходе КАК ПотребоватьСменуПароляПриВходе,
//  |  ТекущаяТаблица.СрокДействияНеОграничен КАК СрокДействияНеОграничен,
//  |  ТекущаяТаблица.СрокДействия КАК СрокДействия,
//  |  ТекущаяТаблица.ПросрочкаРаботыВПрограммеДоЗапрещенияВхода КАК ПросрочкаРаботыВПрограммеДоЗапрещенияВхода
//  |ИЗ
//  |  РегистрСведений.СведенияОПользователях КАК ТекущаяТаблица
//  |ГДЕ
//  |  &УсловиеОтбора";
//  ОбщегоНазначения.ОтборЗаписейНабораИзБазыДанных(НаборЗаписей, Замещение, Запрос);
//  СуществующиеЗаписи = Запрос.Выполнить().Выгрузить();
//
Функция ОтборЗаписейНабораИзБазыДанных(НаборЗаписей, Замещение = Неопределено, Запрос = Неопределено, Экспорт

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

Результат = ОбщегоНазначения.ОтборЗаписейНабораИзБазыДанных(НаборЗаписей, Замещение, Запрос, );

НовыеПараметрыОтбораЗаписейНабораИзБазыДанных

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

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

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

Результат = ОбщегоНазначения.НовыеПараметрыОтбораЗаписейНабораИзБазыДанных()

ЗаписиНабораИзБазыДанных

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

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

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

Результат = ОбщегоНазначения.ЗаписиНабораИзБазыДанных(НаборЗаписей, Замещение, СписокПолей);

ИзменениеЗаписейНабора

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

// Возвращает удаленные и добавленные строки регистра
// для указанного набора записей с учетом режима замещения.
//
// Параметры:
//  ЗаписиИзБазыДанных - см. ЗаписиНабораИзБазыДанных
//
//  НаборЗаписей - РегистрСведенийНаборЗаписей
//               - РегистрНакопленияНаборЗаписей
//               - РегистрБухгалтерииНаборЗаписей
//               - РегистрРасчетаНаборЗаписей - набор записей,
//                   который используется вычисления изменений.
//
//  Замещение - РежимЗамещения, Булево - как передается в подписку на событие ПередЗаписью.
//
//  ТолькоИзменения - Булево - если установить Истина, тогда в результате
//                      не будет строк без изменений (ВидИзмененияСтроки = 0).
//
// Возвращаемое значение:
//  ТаблицаЗначений:
//   * ВидИзмененияСтроки - Число - если 1, то строка добавлена,
//       если -1, то удалена, если 0, то не изменилась.
//   Далее поля из таблицы ЗаписиИзБазыДанных.
//
Функция ИзменениеЗаписейНабора(ЗаписиИзБазыДанных, НаборЗаписей, Замещение, ТолькоИзменения = Ложь) Экспорт

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

Результат = ОбщегоНазначения.ИзменениеЗаписейНабора(ЗаписиИзБазыДанных, НаборЗаписей, Замещение, ТолькоИзменения);

ХранилищеОбщихНастроекСохранить

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

////////////////////////////////////////////////////////////////////////////////
// Сохранение, чтение и удаление настроек из хранилищ.

// Сохраняет настройку в хранилище общих настроек, как метод платформы Сохранить,
// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>,
// но с поддержкой длины ключа настроек более 128 символов путем хеширования части,
// которая превышает 96 символов.
// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки.
//
// Параметры:
//   КлючОбъекта       - Строка           - см. синтакс-помощник платформы.
//   КлючНастроек      - Строка           - см. синтакс-помощник платформы.
//   Настройки         - Произвольный     - см. синтакс-помощник платформы.
//   ОписаниеНастроек  - ОписаниеНастроек - см. синтакс-помощник платформы.
//   ИмяПользователя   - Строка           - см. синтакс-помощник платформы.
//   ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы.
//
Процедура ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт

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

ОбщегоНазначения.ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, );

ХранилищеОбщихНастроекСохранитьМассив

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

// Сохраняет несколько настроек в хранилище общих настроек, как метод платформы Сохранить,
// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>,
// но с поддержкой длины ключа настроек более 128 символов путем хеширования части,
// которая превышает 96 символов.
// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки.
//
// Параметры:
//   НесколькоНастроек - Массив - со значениями:
//     * Значение - Структура:
//         * Объект    - Строка       - см. параметр КлючОбъекта  в синтакс-помощнике платформы.
//         * Настройка - Строка       - см. параметр КлючНастроек в синтакс-помощнике платформы.
//         * Значение  - Произвольный - см. параметр Настройки    в синтакс-помощнике платформы.
//
//   ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы.
//
Процедура ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, Экспорт

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

ОбщегоНазначения.ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, );

ХранилищеОбщихНастроекЗагрузить

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

// Загружает настройку из хранилища общих настроек, как метод платформы Загрузить,
// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>,
// но с поддержкой длины ключа настроек более 128 символов путем хеширования части,
// которая превышает 96 символов.
// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют.
// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки.
//
// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно
// - возвращаемая ссылка заменяется на указанное значение по умолчанию;
// - из данных типа Массив ссылки удаляются;
// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено;
// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно.
//
// Параметры:
//   КлючОбъекта          - Строка           - см. синтакс-помощник платформы.
//   КлючНастроек         - Строка           - см. синтакс-помощник платформы.
//   ЗначениеПоУмолчанию  - Произвольный     - значение, которое возвращается, если настройки не существуют.
//                                             Если не указано, возвращается значение Неопределено.
//   ОписаниеНастроек     - ОписаниеНастроек - см. синтакс-помощник платформы.
//   ИмяПользователя      - Строка           - см. синтакс-помощник платформы.
//
// Возвращаемое значение:
//   Произвольный - см. синтакс-помощник платформы.
//
Функция ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт

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

Результат = ОбщегоНазначения.ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, );

ХранилищеОбщихНастроекУдалить

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

// Удаляет настройку из хранилища общих настроек, как метод платформы Удалить,
// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>,
// но с поддержкой длины ключа настроек более 128 символов путем хеширования части,
// которая превышает 96 символов.
// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки.
//
// Параметры:
//   КлючОбъекта     - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//   КлючНастроек    - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//   ИмяПользователя - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//
Процедура ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт

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

ОбщегоНазначения.ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя)

ХранилищеСистемныхНастроекСохранить

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

// Сохраняет настройку в хранилище системных настроек, как метод платформы Сохранить
// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек
// более 128 символов путем хеширования части, которая превышает 96 символов.
// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки.
//
// Параметры:
//   КлючОбъекта       - Строка           - см. синтакс-помощник платформы.
//   КлючНастроек      - Строка           - см. синтакс-помощник платформы.
//   Настройки         - Произвольный     - см. синтакс-помощник платформы.
//   ОписаниеНастроек  - ОписаниеНастроек - см. синтакс-помощник платформы.
//   ИмяПользователя   - Строка           - см. синтакс-помощник платформы.
//   ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы.
//
Процедура ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт

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

ОбщегоНазначения.ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, );

ХранилищеСистемныхНастроекЗагрузить

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

// Загружает настройку из хранилища системных настроек, как метод платформы Загрузить,
// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек
// более 128 символов путем хеширования части, которая превышает 96 символов.
// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют.
// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки.
//
// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно:
// - возвращаемая ссылка заменяется на указанное значение по умолчанию;
// - из данных типа Массив ссылки удаляются;
// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено;
// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно.
//
// Параметры:
//   КлючОбъекта          - Строка           - см. синтакс-помощник платформы.
//   КлючНастроек         - Строка           - см. синтакс-помощник платформы.
//   ЗначениеПоУмолчанию  - Произвольный     - значение, которое возвращается, если настройки не существуют.
//                                             Если не указано, возвращается значение Неопределено.
//   ОписаниеНастроек     - ОписаниеНастроек - см. синтакс-помощник платформы.
//   ИмяПользователя      - Строка           - см. синтакс-помощник платформы.
//
// Возвращаемое значение:
//   Произвольный - см. синтакс-помощник платформы.
//
Функция ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт

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

Результат = ОбщегоНазначения.ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, );

ХранилищеСистемныхНастроекУдалить

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

// Удаляет настройку из хранилища системных настроек, как метод платформы Удалить,
// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек
// более 128 символов путем хеширования части, которая превышает 96 символов.
// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки.
//
// Параметры:
//   КлючОбъекта     - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//   КлючНастроек    - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//   ИмяПользователя - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//
Процедура ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт

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

ОбщегоНазначения.ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя)

ХранилищеНастроекДанныхФормСохранить

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

// Сохраняет настройку в хранилище настроек данных форм, как метод платформы Сохранить,
// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>,
// но с поддержкой длины ключа настроек более 128 символов путем хеширования части,
// которая превышает 96 символов.
// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки.
//
// Параметры:
//   КлючОбъекта       - Строка           - см. синтакс-помощник платформы.
//   КлючНастроек      - Строка           - см. синтакс-помощник платформы.
//   Настройки         - Произвольный     - см. синтакс-помощник платформы.
//   ОписаниеНастроек  - ОписаниеНастроек - см. синтакс-помощник платформы.
//   ИмяПользователя   - Строка           - см. синтакс-помощник платформы.
//   ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы.
//
Процедура ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт

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

ОбщегоНазначения.ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, );

ХранилищеНастроекДанныхФормЗагрузить

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

// Загружает настройку из хранилища настроек данных форм, как метод платформы Загрузить,
// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>,
// но с поддержкой длины ключа настроек более 128 символов путем хеширования части,
// которая превышает 96 символов.
// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют.
// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки.
//
// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно
// - возвращаемая ссылка заменяется на указанное значение по умолчанию;
// - из данных типа Массив ссылки удаляются;
// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено;
// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно.
//
// Параметры:
//   КлючОбъекта          - Строка           - см. синтакс-помощник платформы.
//   КлючНастроек         - Строка           - см. синтакс-помощник платформы.
//   ЗначениеПоУмолчанию  - Произвольный     - значение, которое возвращается, если настройки не существуют.
//                                             Если не указано, возвращается значение Неопределено.
//   ОписаниеНастроек     - ОписаниеНастроек - см. синтакс-помощник платформы.
//   ИмяПользователя      - Строка           - см. синтакс-помощник платформы.
//
// Возвращаемое значение:
//   Произвольный - см. синтакс-помощник платформы.
//
Функция ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт

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

Результат = ОбщегоНазначения.ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, );

ХранилищеНастроекДанныхФормУдалить

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

// Удаляет настройку из хранилища настроек данных форм, как метод платформы Удалить,
// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>,
// но с поддержкой длины ключа настроек более 128 символов путем хеширования части,
// которая превышает 96 символов.
// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки.
//
// Параметры:
//   КлючОбъекта     - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//   КлючНастроек    - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//   ИмяПользователя - Строка
//                   - Неопределено - см. синтакс-помощник платформы.
//
Процедура ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт

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

ОбщегоНазначения.ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя)

ЗначениеВСтрокуXML

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

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

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

Результат = ОбщегоНазначения.ЗначениеВСтрокуXML(Значение)

ЗначениеИзСтрокиXML

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

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

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

Результат = ОбщегоНазначения.ЗначениеИзСтрокиXML(СтрокаXML)

ОбъектXDTOВСтрокуXML

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

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

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

Результат = ОбщегоНазначения.ОбъектXDTOВСтрокуXML(ОбъектXDTO, Фабрика);

ОбъектXDTOИзСтрокиXML

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

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

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

Результат = ОбщегоНазначения.ОбъектXDTOИзСтрокиXML(СтрокаXML, Фабрика);

ЗначениеВJSON

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

// Преобразует значение в строку JSON при помощи метода глобального контекста ЗаписатьJSON.
// Допускаются не все типы значений, подробности см. в синтакс-помощнике.
// Даты преобразуются в формат ISO (YYYY-MM-DDThh:mm:ssZ).
//
// Параметры:
//  Значение - Произвольный
//
// Возвращаемое значение:
//  Строка
//
Функция ЗначениеВJSON(Знач Значение) Экспорт

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

Результат = ОбщегоНазначения.ЗначениеВJSON(Значение)

JSONВЗначение

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

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

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

Результат = ОбщегоНазначения.JSONВЗначение(Строка, ИменаСвойствСоЗначениямиДата, ПрочитатьВСоответствие);

РазрешенДоступКИнтернетСервисам

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

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

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

Результат = ОбщегоНазначения.РазрешенДоступКИнтернетСервисам(ПоказатьОшибку);

ЗапрещенДоступКИнтернетСервисамТекстСообщения

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

// Текст ошибки при отключенном доступе к сервисам интернета.
//
// Возвращаемое значение:
//  Строка
//
Функция ЗапрещенДоступКИнтернетСервисамТекстСообщения() Экспорт

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

Результат = ОбщегоНазначения.ЗапрещенДоступКИнтернетСервисамТекстСообщения()

НастроитьРаботуСИнтернетСервисами

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

// Устанавливает признак разрешения работа с Интернет-сервисами из приложения. После вызова на клиенте рекомендуется
// вызвать оповещение о записи константы.
//
// Параметры:
//  Разрешить - Булево
//
Процедура НастроитьРаботуСИнтернетСервисами(Разрешить) Экспорт

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

ОбщегоНазначения.НастроитьРаботуСИнтернетСервисами(Разрешить)

ПараметрыПодключенияWSПрокси

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

// Возвращает структуру параметров для функции СоздатьWSПрокси.
//
// Возвращаемое значение:
//   см. СоздатьWSПрокси.ПараметрыПодключенияWSПрокси
//
Функция ПараметрыПодключенияWSПрокси() Экспорт

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

Результат = ОбщегоНазначения.ПараметрыПодключенияWSПрокси()

СоздатьWSПрокси

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

// Конструктор объекта WSПрокси с дополнительными возможностями по сравнению с конструктором Новый WSПрокси:
//  - создает WSОпределения;
//  - кэширует файл WSDL для ускорения работы с веб-сервисом;
//  - не требуется указание ИнтернетПрокси (используется автоматически, если настроен);
//  - позволяет делать быструю проверку доступности сервиса с помощью операции Ping.
//
// Параметры:
//  ПараметрыПодключенияWSПрокси - Структура:
//   * АдресWSDL                    - Строка - месторасположение wsdl, например, "HTTP://webservice.net/webservice.asmx?wsdl".
//   * URIПространстваИмен          - Строка - URI пространства имен web-сервиса, например, "HTTP://www.webservice.net/WebService/1.0.0.1".
//   * ИмяСервиса                   - Строка - имя сервиса, например, "WebService_1_0_0_1".
//   * ИмяТочкиПодключения          - Строка - необязательный параметр. Если не задано, образуется как "<ИмяСервиса>Soap".
//   * ИмяПользователя              - Строка - необязательный параметр. Имя пользователя для входа на сервер.
//   * Пароль                       - Строка - необязательный параметр. Пароль пользователя.
//   * Таймаут                      - Число  - необязательный параметр. Таймаут на операции веб-сервиса, выполняемые
//                                             через прокси. В секундах.
//   * Местоположение               - Строка - необязательный параметр. Фактический адрес сервиса. Используется, если
//                                             адрес реального расположения сервиса отличается от адреса, который указан
//                                             в WSDL-файле.
//   * ИспользоватьАутентификациюОС - Булево - необязательный параметр. Включает использование авторизации NTLM или
//                                             Negotiate на сервере.
//   * ДелатьКонтрольныйВызов       - Булево - необязательный параметр. Выполнять проверку доступности сервиса (требуется
//                                             поддержка команды Ping в веб-сервисе). По умолчанию, Ложь.
//   * ЗащищенноеСоединение         - ЗащищенноеСоединениеOpenSSL
//                                  - Неопределено - необязательные параметры защищенного соединения.
//   * ПроверятьДоставкуПакетовПриОшибке - см. ПолучениеФайловИзИнтернета.ДиагностикаСоединения.ПроверятьДоставкуПакетов.
//   * ПроверятьДоступКИнтернетСервисам - Булево - необязательный параметр, по умолчанию Истина - выполняется проверка
//                                             разрешения доступа к Интернет-сервисам из приложения.
//
// Возвращаемое значение:
//  WSПрокси
//
// Пример:
//  ПараметрыПодключения = ОбщегоНазначения.ПараметрыПодключенияWSПрокси();
//  ПараметрыПодключения.АдресWSDL = "HTTP://webservice.net/webservice.asmx?wsdl";
//  ПараметрыПодключения.URIПространстваИмен = "HTTP://www.webservice.net/WebService/1.0.0.1";
//  ПараметрыПодключения.ИмяСервиса = "WebService_1_0_0_1";
//  ПараметрыПодключения.Таймаут = 20;
//  Прокси = ОбщегоНазначения.СоздатьWSПрокси(ПараметрыПодключения);
//
Функция СоздатьWSПрокси(Знач ПараметрыПодключенияWSПрокси) Экспорт

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

Результат = ОбщегоНазначения.СоздатьWSПрокси(ПараметрыПодключенияWSПрокси)

ПолучитьВерсииИнтерфейса

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

// Возвращает номера версий программных интерфейсов удаленной системы, доступной через веб-сервис.
// Позволяет обеспечивать полную обратную совместимость при изменениях в программных интерфейсах
// с помощью их явного версионирования. Например, если программный интерфейс выше определенной версии,
// то только в этом случае допустимо вызывать у него новую функцию.
//
// В целях экономии трафика при интенсивном взаимодействии между вызывающей и вызываемой сторонами
// сведения о версиях кэшируются на одни сутки. Если для целей отладки требуется сбросить кэш раньше этого времени,
// следует удалить соответствующие записи из регистра сведений КэшПрограммныхИнтерфейсов.
//
// Параметры:
//  Адрес        - Строка - адрес веб-сервиса версионирования интерфейсов InterfaceVersion;
//  Пользователь - Строка - имя пользователя веб-сервиса;
//  Пароль       - Строка - пароль пользователя веб-сервиса;
//  Интерфейс    - Строка - имя запрашиваемого программного интерфейса, например, "СервисПередачиФайлов";
//  ПроверятьДоставкуПакетовПриОшибке - см. ПолучениеФайловИзИнтернета.ДиагностикаСоединения.ПроверятьДоставкуПакетов
//
// Возвращаемое значение:
//   ФиксированныйМассив - массив строк, каждая строка является представлением номера версии интерфейса.
//                         Например, "1.0.2.1".
//
// Пример:
//    Версии = ПолучитьВерсииИнтерфейса("HTTP://vsrvx/sm", "ivanov",, "СервисПередачиФайлов");
//
//    Также для обратной совместимости поддерживается устаревший вариант вызова:
//    ПараметрыПодключения = Новый Структура;
//    ПараметрыПодключения.Вставить("URL", "HTTP://vsrvx/sm");
//    ПараметрыПодключения.Вставить("UserName", "ivanov");
//    ПараметрыПодключения.Вставить("Password", "");
//    Версии = ПолучитьВерсииИнтерфейса(ПараметрыПодключения, "СервисПередачиФайлов");
//
Функция ПолучитьВерсииИнтерфейса(Знач Адрес, Знач Пользователь, Знач Пароль = Неопределено, Экспорт

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

Результат = ОбщегоНазначения.ПолучитьВерсииИнтерфейса(Адрес, Пользователь, Пароль, );

ПолучитьВерсииИнтерфейсаЧерезВнешнееСоединение

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

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

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

Результат = ОбщегоНазначения.ПолучитьВерсииИнтерфейсаЧерезВнешнееСоединение(ВнешнееСоединение, ИмяИнтерфейса)

УдалитьЗаписиКэшаВерсий

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

// Удаляет записи кэша версий программных интерфейсов, содержащих в идентификаторе указанную подстроку.
// В качестве подстроки может использоваться, например, имя интерфейса, более не используемого в конфигурации.
//
// Параметры:
//  ПодстрокаПоискаИдентификаторов - Строка - подстрока поиска идентификаторов.
//                                            Не может содержать символов %, _ и [.
//
Процедура УдалитьЗаписиКэшаВерсий(Знач ПодстрокаПоискаИдентификаторов) Экспорт

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

ОбщегоНазначения.УдалитьЗаписиКэшаВерсий(ПодстрокаПоискаИдентификаторов)

ВерсииИнтерфейсов

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

// Список версий программных интерфейсов, доступных через web-сервис InterfaceVersions.
//
// Возвращаемое значение:
//  Структура:
//     * Ключ - Строка - имя программного интерфейса
//     * Значение - Массив из Строка - поддерживаемые версии интерфейса.
//
Функция ВерсииИнтерфейсов() Экспорт

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

Результат = ОбщегоНазначения.ВерсииИнтерфейсов()

ЗаписатьДанныеВБезопасноеХранилище

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

////////////////////////////////////////////////////////////////////////////////
// Процедуры и функции для работы с хранилищем паролей.

// Записывает конфиденциальные данные в безопасное хранилище.
// Вызывающий код должен самостоятельно устанавливать привилегированный режим.
//
// Безопасное хранилище недоступно для чтения пользователям (кроме администраторов),
// а доступно только коду, который делает обращения только к своей части данных и
// в том контексте, который предполагает чтение или запись конфиденциальных данных.
//
// Параметры:
//  Владелец - ПланОбменаСсылка
//           - СправочникСсылка
//           - Строка - ссылка на объект информационной базы,
//             представляющий объект-владелец сохраняемого пароля или строка до 128 символов.
//             Для объектов других типов в качестве владельца рекомендуется использовать ссылку на
//             элемент метаданных этого типа в справочнике ИдентификаторыОбъектовМетаданных
//             или ключ в виде строки с учетом имен подсистем.
//             Например, для БСП:
//               Владелец = ОбщегоНазначения.ИдентификаторОбъектаМетаданных("РегистрСведений.АдресныеОбъекты");
//             если нужно 1 хранилище на подсистему БСП:
//               Владелец = "СтандартныеПодсистемы.УправлениеДоступом";
//             если нужно более 1 хранилища на подсистему БСП:
//               Владелец = "СтандартныеПодсистемы.УправлениеДоступом.<Уточнение>";
//  Данные  - Произвольный - данные помещаемые в безопасное хранилище. Неопределенно - удаляет все данные.
//            Для удаления данных по ключу следует использовать процедуру УдалитьДанныеИзБезопасногоХранилища.
//          - Структура - если параметр Ключ содержит Неопределено. Подробнее см. описание параметра Ключ
//  Ключ    - Строка       - ключ сохраняемых настроек, по умолчанию "Пароль".
//                           Ключ должен соответствовать правилам имен идентификаторов:
//                           1. Первым символом ключа должна быть буква или символ подчеркивания (_).
//                           2. Каждый из последующих символов может быть буквой, цифрой или символом подчеркивания (_).
//            Неопределено - для добавления набора данных структурой, где ключ структуры - это имя ключа данных,
//            а значение - сохраняемые данные. Пример использования см. ниже.
//
// Пример:
//
//  Процедура ПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи)
//      Если ТекущийПользовательМожетИзменятьПароль Тогда
//          УстановитьПривилегированныйРежим(Истина);
//          ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(ТекущийОбъект.Ссылка, Логин, "Логин");
//          ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(ТекущийОбъект.Ссылка, Пароль);
//          УстановитьПривилегированныйРежим(Ложь);
//      КонецЕсли;
//  КонецПроцедуры
//
//  Процедура ПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи)
//      Если ТекущийПользовательМожетИзменятьПароль Тогда
//          ЛогинИПароль = Новый Структура;
//          ЛогинИПароль.Вставить("Логин", Логин);
//          ЛогинИПароль.Вставить("Пароль", Пароль);
//          УстановитьПривилегированныйРежим(Истина);
//          ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(ТекущийОбъект.Ссылка, ЛогинИПароль, Неопределено);
//          УстановитьПривилегированныйРежим(Ложь);
//      КонецЕсли;
//  КонецПроцедуры
//
Процедура ЗаписатьДанныеВБезопасноеХранилище(Владелец, Данные, Ключ = "Пароль") Экспорт

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

ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(Владелец, Данные, Ключ);

ПрочитатьДанныеВладельцевИзБезопасногоХранилища

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

// Возвращает данные из безопасного хранилища.
// Вызывающий код должен самостоятельно устанавливать привилегированный режим.
//
// Безопасное хранилище недоступно для чтения пользователям (кроме администраторов),
// а доступно только коду, который делает обращения только к своей части данных и
// в том контексте, который предполагает чтение или запись конфиденциальных данных.
//
// Параметры:
//  Владельцы   - Массив из ПланОбменаСсылка
//              - Массив из СправочникСсылка
//              - Массив из Строка - ссылки на объекты информационной базы,
//                  представляющих объекты-владельцы или уникальные строки(до 128 символов) владельцев данных.
//  Ключи       - Строка - содержит имя ключа данных или список имен ключей, указанных через запятую.
//              - Неопределено - будут возвращены все сохраненные данные переданных владельцев.
//  ОбщиеДанные - Булево - Истина, если требуется в модели сервиса получить данные из общих данных в разделенном режиме.
//  ОбластьДанных - Число - содержит номер области данных для которой необходимо выполнить получение данных из
//                    безопасного хранилища области данных. Параметр следует передавать только в случае получения
//                    данных из неразделенного сеанса для области данных. Во всех остальных случаях параметр
//                    игнорируется.
//                   Неопределено - режим получения данных из безопасного хранилища определяется автоматический
//                     по доступности использования разделенных данных.
//
// Возвращаемое значение:
//  Соответствие из КлючИЗначение:
//    * Ключ - ПланОбменаСсылка
//           - СправочникСсылка
//           - Строка - ссылка на объект информационной базы
//                      или строка до 128 символов идентифицирующая владельца данных.
//    * Значение - Произвольный - если в параметре Ключи указан один ключ,
//                                то возвращается его значение произвольного типа.
//               - Структура    - если в параметре Ключи указано несколько ключей или Неопределено,
//                                где ключ структуры - это имя ключа сохраненных данных,
//                                а значение - данные произвольного типа. Когда для ключа отсутствуют данные,
//                                то значение содержит Неопределено.
//               - Неопределено - если данные по ключу отсутствуют.
//
// Пример:
//  Процедура РассылкаПриглашений(Пользователи)
//
//      УстановитьПривилегированныйРежим(Истина);
//      ДанныеАвторизации  = ОбщегоНазначения.ПрочитатьДанныеИзБезопасногоХранилища(Пользователи, "Логин, Пароль");
//      УстановитьПривилегированныйРежим(Ложь);
//
//      Для каждого Пользователь Из Пользователи Цикл
//        ОтправитьПриглашение(Пользователь, ДанныеАвторизации[Пользователь]);
//      КонецЦикла;
//
//  КонецПроцедуры
//
Функция ПрочитатьДанныеВладельцевИзБезопасногоХранилища( Экспорт

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

Результат = ОбщегоНазначения.ПрочитатьДанныеВладельцевИзБезопасногоХранилища();

ПрочитатьДанныеИзБезопасногоХранилища

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

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

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

Результат = ОбщегоНазначения.ПрочитатьДанныеИзБезопасногоХранилища();

УдалитьДанныеИзБезопасногоХранилища

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

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

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

ОбщегоНазначения.УдалитьДанныеИзБезопасногоХранилища(Владелец, Ключи);

СкопироватьСтрокиВБуферОбмена

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

////////////////////////////////////////////////////////////////////////////////
// Процедуры и функции для работы с внутренним буфером обмена.

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

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

ОбщегоНазначения.СкопироватьСтрокиВБуферОбмена(ТабличнаяЧасть, ВыделенныеСтроки, Источник);

СкопироватьВБуферОбмена

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

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

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

ОбщегоНазначения.СкопироватьВБуферОбмена(Данные, Источник);

СтрокиИзБуфераОбмена

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

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

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

Результат = ОбщегоНазначения.СтрокиИзБуфераОбмена()

ПустойБуферОбмена

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

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

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

Результат = ОбщегоНазначения.ПустойБуферОбмена(Источник);

ВыполнитьМетодКонфигурации

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

////////////////////////////////////////////////////////////////////////////////
// Функции для поддержки работы конфигурации с профилем безопасности, в котором
// запрещено подключение внешних модулей без установки безопасного режима.
//

// Выполнить экспортную процедуру по имени с уровнем привилегий конфигурации.
// При включении профилей безопасности для вызова оператора Выполнить() используется
// переход в безопасный режим с профилем безопасности, используемым для информационной базы
// (если выше по стеку не был установлен другой безопасный режим).
//
// Параметры:
//  ИмяМетода  - Строка - имя экспортной процедуры в формате
//                       <имя объекта>.<имя процедуры>, где <имя объекта> - это
//                       общий модуль или модуль менеджера объекта.
//  Параметры  - Массив - параметры передаются в процедуру <ИмяЭкспортнойПроцедуры>
//                        в порядке расположения элементов массива.
//
// Пример:
//  Параметры = Новый Массив();
//  Параметры.Добавить("1");
//  ОбщегоНазначения.ВыполнитьМетодКонфигурации("МойОбщийМодуль.МояПроцедура", Параметры);
//
Процедура ВыполнитьМетодКонфигурации(Знач ИмяМетода, Знач Параметры = Неопределено) Экспорт

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

ОбщегоНазначения.ВыполнитьМетодКонфигурации(ИмяМетода, Параметры);

ВыполнитьМетодОбъекта

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

// Выполнить экспортную процедуру объекта встроенного языка по имени.
// При включении профилей безопасности для вызова оператора Выполнить() используется
// переход в безопасный режим с профилем безопасности, используемым для информационной базы
// (если выше по стеку не был установлен другой безопасный режим).
//
// Параметры:
//  Объект    - Произвольный - объект встроенного языка 1С:Предприятия, содержащий методы (например, ОбработкаОбъект).
//  ИмяМетода - Строка       - имя экспортной процедуры модуля объекта обработки.
//  Параметры - Массив       - параметры передаются в процедуру <ИмяПроцедуры>
//                             в порядке расположения элементов массива.
//
Процедура ВыполнитьМетодОбъекта(Знач Объект, Знач ИмяМетода, Знач Параметры = Неопределено) Экспорт

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

ОбщегоНазначения.ВыполнитьМетодОбъекта(Объект, ИмяМетода, Параметры);

ВыполнитьВБезопасномРежиме

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

// Выполняет произвольный алгоритм на встроенном языке 1С:Предприятия, предварительно устанавливая
// безопасный режим выполнения кода и безопасный режим разделения данных для всех разделителей,
// присутствующих в составе конфигурации.
//
// Для выполняемого кода так же применяются дополнительные ограничения, запрещается:
//
// 1) Вызов методов:
//   - Выполнить
//   - Вычислить
//   - Подключить (для внешних обработок)
//   - ЗафиксироватьТранзакцию
//   - СократитьЖурналРегистрации
//   - УстановитьИспользованиеСобытияЖурналаРегистрации
//   - ЗапуститьПриложение
//
// 2) Вызов общих модулей и свойств глобального контекста:
//   - ДлительныеОперации
//   - ПользователиИнформационнойБазы
//
// Помимо этого рекомендуется вызывать метод вне транзакции, тогда выполняемый код будет
// автоматически выполнен в транзакции с ее отменой по завершении, что позволит более
// надежно защититься от изменения данных выполняемым кодом.
//
// Параметры:
//  Алгоритм  - Строка - алгоритм на встроенном языке "1С:Предприятия".
//  Параметры - Произвольный -  контекст, который требуется для выполнения алгоритма.
//    В тексте алгоритма обращение к контексту должно происходить по имени "Параметры".
//    Например, выражение "Параметры.Значение1 = Параметры.Значение2" обращается к значениям
//    "Значение1" и "Значение2", переданным в Параметры, как свойства.
//  ПараметрыПроверкиАлгоритма - см. ОбщегоНазначения.ПараметрыПроверкиАлгоритма
//    Позволяет указать список методов, модулей и свойств глобального контекста, использование
//    которых не допускается при выполнении алгоритма. Дополняет базовую проверку.
//
// Пример:
//
//  // Пример 1
//  Параметры = Новый Структура;
//  Параметры.Вставить("Значение1", 1);
//  Параметры.Вставить("Значение2", 10);
//  ОбщегоНазначения.ВыполнитьВБезопасномРежиме("Параметры.Значение1 = Параметры.Значение2", Параметры);
//
//  // Пример 2
//  Параметры = Новый Структура;
//  Параметры.Вставить("Источник", Источник);
//  Параметры.Вставить("Результат", Неопределено);
//  ПараметрыПроверкиАлгоритма = ОбщегоНазначения.ПараметрыПроверкиАлгоритма();
//  ПараметрыПроверкиАлгоритма.НедопустимыеМетоды.Добавить("Записать");
//  ПараметрыПроверкиАлгоритма.НедопустимыеМетоды.Добавить("Base64Значение");
//  ОбщегоНазначения.ВыполнитьВБезопасномРежиме(ВычисляемоеВыражение, Параметры, ПараметрыПроверкиАлгоритма);
//
Процедура ВыполнитьВБезопасномРежиме(Знач Алгоритм, Знач Параметры = Неопределено, Экспорт

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

ОбщегоНазначения.ВыполнитьВБезопасномРежиме(Алгоритм, Параметры, );

ВычислитьВБезопасномРежиме

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

// Вычисляет переданное выражение, предварительно устанавливая безопасный режим выполнения кода
// и безопасный режим разделения данных для всех разделителей, присутствующих в составе конфигурации.
//
// Для выполняемого кода так же применяются дополнительные ограничения, запрещается:
//
// 1) Вызов методов:
//   - Выполнить
//   - Вычислить
//   - Подключить (для внешних обработок)
//   - ЗафиксироватьТранзакцию
//   - СократитьЖурналРегистрации
//   - УстановитьИспользованиеСобытияЖурналаРегистрации
//   - ЗапуститьПриложение
//
// 2) Вызов общих модулей и свойств глобального контекста:
//   - ДлительныеОперации
//   - ПользователиИнформационнойБазы
//
// Помимо этого рекомендуется вызывать метод вне транзакции, тогда выполняемый код будет
// автоматически выполнен в транзакции с ее отменой по завершении, что позволит более
// надежно защититься от изменения данных выполняемым кодом.
//
// Параметры:
//  Выражение - Строка - выражение на встроенном языке 1С:Предприятия.
//  Параметры - Произвольный - контекст, который требуется для вычисления выражения.
//    В тексте выражения обращение к контексту должно происходить по имени "Параметры".
//    Например, выражение "Параметры.Значение1 = Параметры.Значение2" обращается к значениям
//    "Значение1" и "Значение2" переданные в Параметры, как свойства.
//  ПараметрыПроверкиАлгоритма - см. ОбщегоНазначения.ПараметрыПроверкиАлгоритма
//    Позволяет указать список методов, модулей и свойств глобального контекста, использование
//    которых не допускается при выполнении алгоритма. Дополняет базовую проверку.
//
// Возвращаемое значение:
//   Произвольный - результат вычисления выражения.
//
// Пример:
//
//  // Пример 1
//  Параметры = Новый Структура;
//  Параметры.Вставить("Значение1", 1);
//  Параметры.Вставить("Значение2", 10);
//  Результат = ОбщегоНазначения.ВычислитьВБезопасномРежиме("Параметры.Значение1 = Параметры.Значение2", Параметры);
//
//  // Пример 2
//  Результат = ОбщегоНазначения.ВычислитьВБезопасномРежиме("СтандартныеПодсистемыСервер.ВерсияБиблиотеки()");
//
Функция ВычислитьВБезопасномРежиме(Знач Выражение, Знач Параметры = Неопределено, Экспорт

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

Результат = ОбщегоНазначения.ВычислитьВБезопасномРежиме(Выражение, Параметры, );

ОписаниеЗащитыБезПредупреждений

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

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

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

Результат = ОбщегоНазначения.ОписаниеЗащитыБезПредупреждений()

ПараметрыПроверкиАлгоритма

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

// Конструктор структуры для параметра ПараметрыПроверкиАлгоритма функций
// ОбщегоНазначения.ВыполнитьВБезопасномРежиме и ОбщегоНазначения.ВычислитьВБезопасномРежиме.
//
// Возвращаемое значение:
//   Структура:
//     * НедопустимыеМетоды - Массив из Строка - список методов, вызов которых не допускается при
//         выполнении алгоритма.
//     * ЗапрещенныеСвойстваГлобальногоКонтекста - Массив из Строка - список свойств глобального контекста,
//         обращение к которым не допускается при выполнении алгоритма.
//     * ЗапрещенныеМодули - Массив из Строка - список модулей, использование которых не допускается при
//         выполнении алгоритма.
//
Функция ПараметрыПроверкиАлгоритма() Экспорт

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

Результат = ОбщегоНазначения.ПараметрыПроверкиАлгоритма()

СформироватьСтрокуДляПоискаВЗапросе

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

// Подготавливает строку для использования в качестве шаблона поиска в запросе с оператором ПОДОБНО.
// Экранирует служебные символы, если они есть в строке.
//
// Параметры:
//  СтрокаПоиска - Строка - произвольная строка.
//
// Возвращаемое значение:
//  Строка
//
// Пример:
//   ВЫБРАТЬ
//    Номенклатура.Ссылка КАК Ссылка
//  ИЗ
//    Справочник.Номенклатура КАК Номенклатура
//  ГДЕ
//    Номенклатура.Наименование ПОДОБНО &Шаблон СПЕЦСИМВОЛ "~"
//
//  Запрос.УстановитьПараметр("Шаблон", ОбщегоНазначения.СформироватьСтрокуДляПоискаВЗапросе(ИскомыйТекст));
//
Функция СформироватьСтрокуДляПоискаВЗапросе(Знач СтрокаПоиска) Экспорт

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

Результат = ОбщегоНазначения.СформироватьСтрокуДляПоискаВЗапросе(СтрокаПоиска)

РазделительПакетаЗапросов

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

// Возвращает фрагмент текста запроса, отделяющего один запрос от другого.
//
// Возвращаемое значение:
//  Строка - разделитель запросов.
//
Функция РазделительПакетаЗапросов() Экспорт

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

Результат = ОбщегоНазначения.РазделительПакетаЗапросов()

ТекстОбъединитьВсе

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

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

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

Результат = ОбщегоНазначения.ТекстОбъединитьВсе()

ПриНачалеВыполненияРегламентногоЗадания

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

// Выполняет проверки перед выполнением обработчика регламентного задания и прерывает выполнение,
// если его запуск в данный момент невозможен, например:
//  - еще не завершено обновление программы;
//  - запуск через консоль или другим способом, минуя включение функциональной опции
//    (если регламентное задание зависит от функциональных опций);
//  - попытка выполнения задания, работающего с внешними ресурсами в копии информационной базы.
//
// Параметры:
//  РегламентноеЗадание - ОбъектМетаданныхРегламентноеЗадание - регламентное задание,
//    из которого вызывается данная процедура.
//
// Пример:
// ОбщегоНазначения.ПриНачалеВыполненияРегламентногоЗадания(Метаданные.РегламентныеЗадания.<ИмяРегламентногоЗадания>);
//
Процедура ПриНачалеВыполненияРегламентногоЗадания(РегламентноеЗадание = Неопределено) Экспорт

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

ОбщегоНазначения.ПриНачалеВыполненияРегламентногоЗадания(РегламентноеЗадание);

ОчиститьПараметрыСеанса

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

// Переводит параметры сеанса в состояние "Не установлено".
//
// Параметры:
//  ПараметрыДляОчистки - Строка - имена параметров сеанса для очистки, разделенные ",".
//  Исключения          - Строка - имена параметров сеанса не предназначенные для очистки, разделенные ",".
//
Процедура ОчиститьПараметрыСеанса(ПараметрыДляОчистки = "", Исключения = "") Экспорт

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

ОбщегоНазначения.ОчиститьПараметрыСеанса(ПараметрыДляОчистки, Исключения);

ПроверитьВыводТабличногоДокумента

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

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

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

Результат = ОбщегоНазначения.ПроверитьВыводТабличногоДокумента(ТабДокумент, ВыводимыеОбласти, РезультатПриОшибке);

СохранитьПерсональныеНастройки

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

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

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

ОбщегоНазначения.СохранитьПерсональныеНастройки(Настройки)

РаспределитьСуммуПропорциональноКоэффициентам

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

// Выполняет пропорциональное распределение суммы в соответствии
// с заданными коэффициентами распределения.
//
// Параметры:
//  РаспределяемаяСумма - Число  - сумма, которую надо распределить, если сумма равна 0 - то возвращается Неопределено;
//                                 Если передана отрицательная - расчет по модулю и после инверсия знаков результата.
//  Коэффициенты        - Массив из Число - коэффициенты распределения, должны быть положительны или отрицательными
//                                          одновременно.
//  Точность            - Число  - точность округления при распределении.
//
// Возвращаемое значение:
//  Массив из Число - массив размерностью равный массиву коэффициентов, содержит
//           суммы в соответствии с весом коэффициента (из массива коэффициентов).
//           В случае, если распределить невозможно (кол-во коэффициентов = 0
//           есть коэффициенты с отрицательным значением или суммарный вес коэффициентов = 0),
//           тогда будет возвращено Неопределено.
//
// Пример:
//
//  Коэффициенты = Новый Массив;
//  Коэффициенты.Добавить(1);
//  Коэффициенты.Добавить(2);
//  Результат = ОбщегоНазначенияКлиентСервер.РаспределитьСуммуПропорциональноКоэффициентам(1, Коэффициенты);
//  // Результат = [0.33, 0.67]
//
Функция РаспределитьСуммуПропорциональноКоэффициентам( Экспорт

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

Результат = ОбщегоНазначения.РаспределитьСуммуПропорциональноКоэффициентам();

ЗаполнитьКоллекциюЭлементовДереваДанныхФормы

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

// Процедура предназначена для заполнения реквизита формы типа ДанныеФормыДерево.
//
// Параметры:
//  КоллекцияЭлементовДерева - ДанныеФормыКоллекцияЭлементовДерева - реквизит, который нужно заполнить.
//  ДеревоЗначений           - ДеревоЗначений    - данные для заполнения.
//
Процедура ЗаполнитьКоллекциюЭлементовДереваДанныхФормы(КоллекцияЭлементовДерева, ДеревоЗначений) Экспорт

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

ОбщегоНазначения.ЗаполнитьКоллекциюЭлементовДереваДанныхФормы(КоллекцияЭлементовДерева, ДеревоЗначений)

ПодключитьКомпонентуИзМакета

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

// Подключает внешнюю компоненту, выполненную по технологии Native API или COM,
// из макета конфигурации (хранится в виде ZIP-архива).
//
// Параметры:
//   Идентификатор   - Строка - идентификатор объекта внешней компоненты.
//   ПолноеИмяМакета - Строка - полное имя макета конфигурации с ZIP-архивом.
//   Изолированно    - Булево - если Истина, компонента должна подключаться изолированно,
//                              в этом случае она загружается в отдельный процесс операционной системы.
//                              Если Ложь, то в этом случае компонента будет выполняться в том же процессе
//                              операционной системы, который выполняет код встроенного языка.
//                   - Неопределено - (по умолчанию Неопределено) соответствует поведению платформы:
//                              не изолированно - если компонентой поддерживается только этот режим,
//                              изолированно - в остальных случаях.
//                              См. https://its.1c.eu/db/v83doc#bookmark:dev:TI000001866
//
// Возвращаемое значение:
//   - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты.
//   - Неопределено - если не удалось создать.
//
// Пример:
//
//  ПодключаемыйМодуль = ОбщегоНазначения.ПодключитьКомпонентуИзМакета(
//      "QRCodeExtension",
//      "ОбщийМакет.КомпонентаПечатиQRКода");
//
//  Если ПодключаемыйМодуль <> Неопределено Тогда
//      // ПодключаемыйМодуль содержит созданный экземпляр подключенной компоненты.
//  КонецЕсли;
//
//  ПодключаемыйМодуль = Неопределено;
//
Функция ПодключитьКомпонентуИзМакета(Знач Идентификатор, Знач ПолноеИмяМакета, Знач Изолированно = Неопределено) Экспорт

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

Результат = ОбщегоНазначения.ПодключитьКомпонентуИзМакета(Идентификатор, ПолноеИмяМакета, Изолированно);

ЭтоДобавлениеНабораЗаписей

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

// Проверяет, что указанный режим соответствует добавлению набора записей.
//
// Параметры:
//  Режим - Булево, РежимЗамещения
//
// Возвращаемое значение:
//  Булево
//
Функция ЭтоДобавлениеНабораЗаписей(Режим) Экспорт

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

Результат = ОбщегоНазначения.ЭтоДобавлениеНабораЗаписей(Режим)

ЭтоЗамещениеНабораЗаписей

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

// Проверяет, что указанный режим соответствует замещению набора записей.
//
// Параметры:
//  Режим - Булево, РежимЗамещения
//
// Возвращаемое значение:
//  Булево
//
Функция ЭтоЗамещениеНабораЗаписей(Режим) Экспорт

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

Результат = ОбщегоНазначения.ЭтоЗамещениеНабораЗаписей(Режим)

ЭтоОбновлениеНабораЗаписей

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

// Проверяет, что указанный режим соответствует обновлению набора записей.
//
// Параметры:
//  Режим - Булево, РежимЗамещения
//
// Возвращаемое значение:
//  Булево
//
Функция ЭтоОбновлениеНабораЗаписей(Режим) Экспорт

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

Результат = ОбщегоНазначения.ЭтоОбновлениеНабораЗаписей(Режим)

ЭтоСлияниеНабораЗаписей

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

// Проверяет, что указанный режим соответствует слиянию набора записей.
//
// Параметры:
//  Режим - Булево, РежимЗамещения
//
// Возвращаемое значение:
//  Булево
//
Функция ЭтоСлияниеНабораЗаписей(Режим) Экспорт

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

Результат = ОбщегоНазначения.ЭтоСлияниеНабораЗаписей(Режим)

ЭтоУдалениеНабораЗаписей

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

// Проверяет, что указанный режим соответствует удалению набора записей.
//
// Параметры:
//  Режим - Булево, РежимЗамещения
//
// Возвращаемое значение:
//  Булево
//
Функция ЭтоУдалениеНабораЗаписей(Режим) Экспорт

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

Результат = ОбщегоНазначения.ЭтоУдалениеНабораЗаписей(Режим)

РежимОбновленияНабораЗаписей

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

// Возвращает РежимЗамещения.Обновление или Неопределено,
// если не поддерживается в текущей версии 1С:Предприятия.
//
// Возвращаемое значение:
//  Неопределено, РежимЗамещения
//
Функция РежимОбновленияНабораЗаписей() Экспорт

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

Результат = ОбщегоНазначения.РежимОбновленияНабораЗаписей()

РежимСлиянияНабораЗаписей

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

// Возвращает РежимЗамещения.Слияние или Неопределено,
// если не поддерживается в текущей версии 1С:Предприятия.
//
// Возвращаемое значение:
//  Неопределено, РежимЗамещения
//
Функция РежимСлиянияНабораЗаписей() Экспорт

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

Результат = ОбщегоНазначения.РежимСлиянияНабораЗаписей()

РежимУдаленияНабораЗаписей

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

// Возвращает РежимЗамещения.Удаление или Неопределено,
// если не поддерживается в текущей версии 1С:Предприятия.
//
// Возвращаемое значение:
//  Неопределено, РежимЗамещения
//
Функция РежимУдаленияНабораЗаписей() Экспорт

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

Результат = ОбщегоНазначения.РежимУдаленияНабораЗаписей()

ИспользованиеРазделителяСеанса

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

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

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

Результат = ОбщегоНазначения.ИспользованиеРазделителяСеанса()

СоздатьВременныйКаталог

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

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

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

Результат = ОбщегоНазначения.СоздатьВременныйКаталог(Расширение);

УдалитьВременныйКаталог

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

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

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

ОбщегоНазначения.УдалитьВременныйКаталог(ПутьККаталогу)

ЕстьЗащитаОтОпасныхДействий

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

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

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

Результат = ОбщегоНазначения.ЕстьЗащитаОтОпасныхДействий()

ОбъектПоПолномуИмени

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

// Устарела. Создает и возвращает экземпляр отчета или обработки по полному имени объекта метаданных.
//
// Параметры:
//  ПолноеИмя - Строка - полное имя объекта метаданных. Пример: "Отчет.БизнесПроцессы".
//
// Возвращаемое значение:
//  ОтчетОбъект
//  ОбработкаОбъект - экземпляр отчета или обработки.
//
Функция ОбъектПоПолномуИмени(ПолноеИмя) Экспорт

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

Результат = ОбщегоНазначения.ОбъектПоПолномуИмени(ПолноеИмя)

ЭтоOSXКлиент

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

// Устарела. Следует использовать ОбщегоНазначения.ЭтоMacOSКлиент
// Возвращает Истина, если клиентское приложение запущено под управлением ОС X.
//
// Возвращаемое значение:
//  Булево - если нет клиентского приложения, возвращается Ложь.
//
Функция ЭтоOSXКлиент() Экспорт

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

Результат = ОбщегоНазначения.ЭтоOSXКлиент()

---

© 2024, ООО 1С-Софт
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии Attribution 4.0 International (CC BY 4.0).

---