1.4.5. Специальные процедуры и функции.

    1.4.5.1. ЗапуститьПриложение(RunApp)

   Русскоязычный синтаксис:

   ЗапуститьПриложение(<СтрокаКоманды>,<СтрокаПараметров>)

   Англоязычный синтаксис:

   RunApp(<CommandString>,<ParametersString>)

   Назначение:  

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

   Параметры: 

   <СтрокаКоманды> - имя приложения или имя файла, чтобы открыть его с помощью ассоциированного для данного вида файлов приложения.

   <СтрокаПараметров> - строка параметров  запуска, которые должны быть в командной строке.
Последовательность поиска программы (если не задан путь):
текущий системный каталог;
каталог Windows;
системный каталог Windows;
все каталоги, указанные в переменной PATH..

     1.4.5.2. ОткрытьФорму(OpenForm)

     Русскоязычный синтаксис:

     ОткрытьФорму(<ИмяФормы>|<ОписательОбъекта>,

                                  <Конт>,<ИмяФайла>,<Ид>,<Парам1>,

                                  <КонтекстОткрытия>,<РежимПодбора>,<ЗначениеПодбора>)

     Англоязычный синтаксис:

     OpenForm(<FormName>|<ObjectName>,

                       <Cont>,<FileName>,<Id>,<Par1>,

                       <OpenCont>,<ChoiceMode>,<ChoiceValue>)

     Назначение:  

     Запуск произвольной формы на исполнение (форма это совокупность визуального диалога и программного модуля)
Возвращает: 1 - если действие выполнено, 0 - иначе.
  

     Параметры:

     <ИмяФормы> - имя формы (абсолютный путь) ресурса файла конфигурации (файл md2). Если имя задано без полного пути, то форма вначале ищется в локальном контексте объекта, потом среди общих форм. Также может быть указан объект или его строковое описание.
     <Конт> - параметр для формы при открытии формы и контекст формы после открытия.
     <ИмяФайла> - имя файла внешней формы, если задан этот параметр, то параметр ИмяФормы игнорируется.
     <Ид> - уникальный текстовый идентификатор, который служит для проверки того, что следует ли создавать новую форму или нужно активизировать окно уже открытой формы, если форма с аналогичным именем уже была открыта. Этот параметр игнорируется при открытии формы из файла.

     <Парам1> - дополнительный параметр, может использоваться при открытии формы объекта (например: владелец элемента справочника.
     <КонтекстОткрытия> - контекст для открытия формы в режиме подбора.

     <РежимПодбора> - режим подбора.
     <ЗначениеПодбора> - переменная, объявленная в модуле, куда передается выбранное значение подбора.

    1.4.5.3. ОткрытьФормуМодально(OpenFormModal)

     Русскоязычный синтаксис:

     ОткрытьФормуМодально(<ИмяФормы>|<ОписательОбъекта>,

                                  <Конт>,<ИмяФайла>,<Ид>,<Парам1>,

                                  <КонтекстОткрытия>,<РежимПодбора>,<ЗначениеПодбора>)

     Англоязычный синтаксис:

     OpenFormModal(<FormName>|<ObjectName>,

                       <Cont>,<FileName>,<Id>,<Par1>,

                       <OpenCont>,<ChoiceMode>,<ChoiceValue>)

    Назначение:  

    Запуск произвольной формы на исполнение в модальном режиме.
Возвращает: 1 - если действие выполнено, 0 - иначе.
  

    Параметры: 

    <ИмяФормы> - имя формы (абсолютный путь) ресурса файла конфигурации (файл md2). Если имя задано без полного пути, то форма вначале ищется в локальном контексте объекта, потом среди общих форм. Также может быть указан объект или его строковое описание.
    <Конт> - параметр для формы при открытии формы и контекст формы после открытия.
    <ИмяФайла> - имя файла внешней формы, если задан этот параметр, то параметр ИмяФормы игнорируется.
    <Ид> - уникальный текстовый идентификатор, который служит для проверки того, что следует ли создавать новую форму или нужно активизировать окно уже открытой формы, если форма с аналогичным именем уже была открыта. Этот параметр игнорируется при открытии формы из файла.

    <Парам1> - дополнительный параметр, может использоваться при открытии формы объекта (например: владелец элемента справочника.
    <КонтекстОткрытия> - контекст для открытия формы в режиме подбора.

    <РежимПодбора> - режим подбора.
    <ЗначениеПодбора> - переменная, объявленная в модуле, куда передается выбранное значение подбора.

    1.4.5.4. ОткрытьФормуРедактирования(OpenFormEdit)

     Русскоязычный синтаксис:

     ОткрытьФормуРедактирования(<ИмяФормы>,<Конт>,<ИмяФайла>,<Ид>)

     Англоязычный синтаксис:

     OpenFormEdit(<FormName>,<Cont>,<FileName>,<Id>)

     Назначение:  

     Открывает форму в режиме редактирования.
Возвращает: 1 - если действие выполнено, 0 - иначе.
  

     Параметры:

     <ИмяФормы> - имя формы (абсолютный путь) ресурса файла конфигурации (файл md2). Если имя задано без полного пути, то форма вначале ищется в локальном контексте объекта, потом среди общих форм.
    <Конт> - параметр для формы при открытии формы и контекст формы после открытия.
    <ИмяФайла> - имя файла внешней формы, если задан этот параметр, то параметр ИмяФормы игнорируется.
    <Ид> - уникальный текстовый идентификатор, который служит для проверки того, что следует ли создавать новую форму или нужно активизировать окно уже открытой формы, если форма с аналогичным именем уже была открыта. Этот параметр игнорируется при открытии формы из файла.

    1.4.5.5. ОткрытьПодбор(OpenPermanentChoice)

     Русскоязычный синтаксис:

     ОткрытьПодбор(<Объект>,<ИмяФормы><Конт>,<ФлагМножВыбора>,<ТекЗначение>)

     Англоязычный синтаксис:

     OpenPermanentChoice(<Object>,<FormName><Cont>,<FlagPermanentChoice>,<CurrentValue>)

     Назначение:  

     Открывает форму в режиме подбора.
Возвращает: 1 - если действие выполнено, 0 - иначе.
  

     Параметры: 

     <Объект> - объект или строковое описание объекта 

    <ИмяФормы> - имя формы (абсолютный путь) ресурса файла конфигурации (файл md2). Если имя задано без полного пути, то форма вначале ищется в локальном контексте объекта, потом среди общих форм.

    <Конт> - контекст для открытия формы в режиме подбора.

    <ФлагМножВыбора> - режим подбора.
    <ТекЗначение> - переменная, объявленная в модуле, куда передается выбранное значение подбора.

     1.4.5.6. Ошибка(Error)

     Русскоязычный синтаксис:

     Ошибка(<СтрОшибки>)

    Англоязычный синтаксис:

    Error(<ErrorString>)

    Назначение:  

    Вызвать ошибку исполнения.
 

    Параметры: 

    <СтрОшибка> - строка ошибки. 

    1.4.5.7. ОписаниеОшибки(GetErrorDescription)

     Русскоязычный синтаксис:

     ОписаниеОшибки(<Стр>)

     Англоязычный синтаксис:

     GetErrorDescription(<Str>)

     Назначение:  

     Получить/установить описание ошибки в виде <ИмяМодуля> <НомерСтроки> <ОписаниеОшибки>.

     Возвращает предыдущее описание ошибки.
  

     Параметры: 

    <Стр> - описание ошибки.

     1.4.5.8. ЕстьНеобработаннаяОшибка(HasError)

     Русскоязычный синтаксис:

     ЕстьНеобработаннаяОшибка(<Флаг>)

     Англоязычный синтаксис:

     HasError(<Flag>)

     Назначение:  

     Получить/установить флаг необработанной ошибки.

     Возвращает предыдущее состояние флага.
  

     Параметры: 

     <Флаг> - флаг необработанной ошибки.

    1.4.5.9. ПустоеЗначение(EmptyValue)

     Русскоязычный синтаксис:

     ПустоеЗначение(<Значение>)

      Англоязычный синтаксис:

     EmptyValue(<Value>)

     Назначение:  

     Функция определяет, является ли пустым переданное в параметре значение. Возвращает число: 1- если значение пустое и 0 - если нет. При этом применяется следующее правило:
- значение неопределенного типа - всегда пустое;
- значение типа ''строка'' проверяется как в методе ПустаяСтрока;
- значение типа ''число'' проверяется на равенство нулю;
- значение типа ''дата'' проверяется на пустое значение;
- значения следующих типов: ''справочник'', ''перечисление'', ''документ'', ''счет'', ''вид субконто'', ''план счетов'', ''календарь'' проверяются как в методах Выбран для соответствующего типа объекта.;
- значение типа ''СписокЗначений'' считается пустым, если в нем нет значений;
- значение типа ''ТаблицаЗначений'' считается пустым, если нет ни одной строки таблицы.
  

    Параметры: 

    <Значение> - выражение любого типа, значение которого проверяется.

    1.4.5.10. СоздатьОбъект(CreateObject)

     Русскоязычный синтаксис:

    СоздатьОбъект(<ИмяАгрегатногоТипа>)

    Англоязычный синтаксис:

    CreateObject(<AggregateTypeName>)

    Назначение:  

    Создает объект агрегатного типа данных. Возвращает ссылку на созданный объект агрегатного типа.
  

    Параметры: 

    <ИмяАгрегатногоТипа> - строковое выражение, содержащее имя агрегатного типа данных.

    1.4.5.11. СтатусВозврата(ReturnStatus)

     Русскоязычный синтаксис:

    СтатусВозврата(<Статус>)

    Англоязычный синтаксис:

    ReturnStatus(<Status>)

    Назначение:  

    Определение или установка статуса возврата предопределенной процедуры.
    Возвращает:
    1, если статус возврата - Выполнить Действие;
    0, если статус возврата - Отменить Действие.
  

    Параметры: 

    <Статус> - - необязательный параметр:
если опущен, то установка статуса возврата предопределенной процедуры не меняется;
если задано 1, то устанавливается статус возврата - Выполнить Действие;
если задано 0, то устанавливается статус возврата - Отменить Действие.
    Замечание:
Функция/процедура СтатусВозврата применяется в теле предопределенных процедур.
Начальное значение статуса возврата предопределенной процедуры равно 1 - Выполнить Действие, устанавливается системой при вызове предопределенной процедуры.

     1.4.5.12. ТипЗначения(ValueType)

     Русскоязычный синтаксис:

    ТипЗначения(<Значение>)

    Англоязычный синтаксис:

    ValueType(<Value>)

    Назначение:  

    Возвращает:
    тип данных значения в виде числа.
  

    Параметры: 

    <Значение> - выражение, тип данных значения которого надо определить.
Возвращаемые значения типов данных:
0 - неопределенный тип данных;
1 - числовой тип данных;
2 - строковый тип данных;
3 - тип данных Дата;
100 - агрегатный объект 
 

    1.4.5.13. ТипЗначенияСтр(ValueTypeStr)

     Русскоязычный синтаксис:

    ТипЗначенияСтр(<Значение>)

    Англоязычный синтаксис:

    ValueTypeStr(<Value>)

    Назначение:  

    Возвращает:
    тип данных значения в виде строки.
  

    Параметры: 

    <Значение> - выражение, тип данных значения которого надо определить.
Возвращаемые значения типов данных:
"Неопределенный" - неопределенный тип данных;
"Число" - числовой тип данных;
"Строка" - строковый тип данных;
"Дата" - тип данных Дата;
    Замечание:
    Для агрегатных объектов уровня 1 возвращаемое значение определяется функцией объекта ПолучитьТипДанных(). 
 

     1.4.5.14. УстановитьТолькоЧтение(SetReadOnly)

     Русскоязычный синтаксис:

     УстановитьТолькоЧтение(<Перем>,<Флаг>)

    Англоязычный синтаксис:

     SetReadOnly(<Variable>,<Flag>)

    Назначение:  

    Установить или снять режим доступа к переменной только на чтение.
  

    Параметры: 

    <Переменная> - обрабатываемая переменная
    <Флаг> - числовове выражение: 1 - установить режим ''Только чтение'' (т.е. переменной нельзя присваивать значение), 0 - отменить режим ''Только чтение''

    Пример:
ФС=СоздатьОбъект(''Файловая система'');
УстановитьТолькоЧтение(ФС,1);  

    1.4.5.15. НажатаяКлавиша(GetKeyDown)

      Русскоязычный синтаксис:

     НажатаяКлавиша()

    Англоязычный синтаксис:

    GetKeyDown()

    Назначение:  

    Определить код последней нажатой клавиши.
  

    Параметры: 

    нет

    1.4.5.16. СостояниеКлавиши(GetKeyState)

      Русскоязычный синтаксис:

     СостояниеКлавиши(<КодИлиНаименованиеКлавиши>)

     Англоязычный синтаксис:

     GetKeyState(<KeyCodeOrName>)

     Назначение:  

     Определить нажата ли клавиша с данным кодом или наименованием.
  

      Параметры: 

     <КодИлиНаименованиеКлавиши> - числовое или строковое выражение - код или наименование клавиши.

    1.4.5.17. Формат(Format)

      Русскоязычный синтаксис:

     Формат(<Значение>,<СтрокаФормата>)

     Англоязычный синтаксис:

     Format(<Value>,<FormatString)

     Назначение:  

     Возвращает строковое значение в формате, определяемом форматной строкой.
  

      Параметры: 

     <Значение> - форматируемое выражение,

     <СтрокаФормата> - форматная строка.

Форматная строка имеет вид:

для чисел - 'Nm.n<разделитель дробной><разделитель триад>' (в русском регистре вместо N - Ч);

для денежных величин - 'NSMH' (в русском регистре - 'ЧПДС');

для строк - 'Sn' (в русском регистре - 'Сn');

для дат - 'DПодстрокаФормата' (в русском регистре вместо D - Д), где

ПодстрокаФормата может быть вида:

DDMMYY (ДДММГГ), дата в виде - ДД.ММ.ГГ;

DDMMYYYY (ДДММГГГГ), дата в виде - ДД.ММ.ГГГГ;

DDMMMMYYYY (ДДММММГГГГ), дата в виде - ДД месяц прописью ГГГГ;

(0)DDMMMMYYYY ((0)ДДММММГГГГ) этот формат представляет собой вариант предыдущего формата с тем отличием, что число месяца всегда выводится двумя цифрами, т.е. для чисел меньших 10 спереди будет добавлен 0. Например: Формат('01.01.1999', ''Д (0)ДДММММГГГГ'') = 01 Января 1999 г.

MMMMYYYY (ММММГГГГ), дата в виде - месяц прописью ГГГГ;

MMMMYY (ММММГГ), дата в виде - месяц прописью ГГ;

QQQQYYYY (ККККГГГГ), дата в виде - N квартал ГГГГ;

QQQQYY (ККККГГ), дата в виде - N квартал ГГ;

YYYYMMDD (ГГГГММДД), дата в виде ГГГГММДД, то есть дата '10.11.1998' будет представлена как строка ''19981110'';

WWWW (НННН), выводит наименование дня недели, соответсвующее указанной дате. Наименования дней недели берутся из файла прописи.

Замечание:

Для чисел: наличие ''0'' перед длиной поля подавляет отображение нулевых значений (выводится пустая строка). Пример: ''Ч015.2'';

Символ ''-'' перед длиной поля означает, что нулевые значения при выводе будут отображаться прочерком. Пример: ''Ч-17.2''.;

Если форматная строка заканчивается символами >X, происходит сдвиг отображаемых разрядов на X позиций.

Если в форматной строке указано ''(0)'', то данная последовательность символов должна быть первой в формате и предшествовать всем прочим спецификациям. При задании такой спецификации все позиции в поле вывода числа, соответствующие незадействованным старшим разрядам, будут заполнены символами ''0''. Например: Формат(123.15, ''Ч (0)10.2'') = 0000123.15;

     1.4.5.18. Шаблон(Template)

     Русскоязычный синтаксис:

     Шаблон(<СтрокаШаблона>)

     Англоязычный синтаксис:

     Template(<TemplateString)

     Назначение:  

     Возвращает строку, полученную по шаблону заменой встроенных выражений на значения и форматированием.
  

      Параметры: 

     <СтрокаШаблона> - строка, содержащая шаблон формирования.   

    1.4.5.19. ЗарегистрироватьОбъект(AttachRegisterObject)

      Русскоязычный синтаксис:

     ЗарегистрироватьОбъект(<РодительскийКласс>,<ДочернийКласс>)

     Англоязычный синтаксис:

     AttachRegisterObject(<ParentClass>,<ChildClass>)

     Назначение:  

     Динамическая регистрация агрегатного объекта в системе.
  

     Параметры: 

     <РодительскийКласс> - строка, содержащая имя уже зарегистрированного объекта.   

     <ДочернийКласс> - строка, содержащая имя регистрируемого объекта.   

     1.4.5.20. ОтменитьРегистрациюОбъекта(UnRegisterObject)

      Русскоязычный синтаксис:

     ОтменитьРегистрациюОбъекта(<ИмяОбъекта>)

     Англоязычный синтаксис:

     UnRegisterObject(<ObjectName>)

     Назначение:  

     Динамическая отмена регистрации агрегатного объекта в системе.
  

     Параметры: 

     <ИмяОбъекта> - строка, содержащая имя зарегистрированного объекта.   

    1.4.5.21. ПолучитьКонтекстВызова(GetCallContext)

      Русскоязычный синтаксис:

     ПолучитьКонтекстВызова()

     Англоязычный синтаксис:

     GetCallContext()

     Назначение:  

     Возвращает контекст модуля, вызвавшего текущий исполняемый модуль.
  

     Параметры: 

     нет.   

    1.4.5.22. ПолучитьМассивЛексем(GetLexemArray)

      Русскоязычный синтаксис:

     ПолучитьМассивЛексем(<ИмяМодуля>)

     Англоязычный синтаксис:

     GetLexemArray(<ModuleName>)

     Назначение:  

     Возвращает массив лексем указанного модуля. 
  

      Параметры: 

     <ИмяМодуля> - строка, содержащая имя модуля.   

     1.4.5.23. ПолучитьМассивСистемныхОбъектов(GetRegisterObjectArray)

      Русскоязычный синтаксис:

     ПолучитьМассивСистемныхОбъектов()

     Англоязычный синтаксис:

     GetRegisterObjectArray()

     Назначение:  

     Возвращает массив зарегистрированных в системе объектов. 
  

     Параметры: 

     нет.

    1.4.5.24. Сигнал(Beep)

      Русскоязычный синтаксис:

     Сигнал()

     Англоязычный синтаксис:

     Beep()

     Назначение:  

     Вывести звуковой сигнал. 
  

     Параметры: 

     нет.

    1.4.5.25. ПСЧ(Rand)

      Русскоязычный синтаксис:

     ПСЧ()

     Англоязычный синтаксис:

     Rand()

     Назначение:  

     Возвращает случайное число. 
  

     Параметры: 

     нет.

    1.4.5.26. ПолучитьХэш(GetHash)

      Русскоязычный синтаксис:

     ПолучитьХэш(<Строка>)

     Англоязычный синтаксис:

     GetHash(<String>)

     Назначение:  

     Возвращает значение хэш-функции для строкового значения. 
  

     Параметры: 

     нет.

     1.4.5.27. Выражение(Eval)

      Русскоязычный синтаксис:

     Выражение(<Строка>)

     Англоязычный синтаксис:

     Eval(<String>)

     Назначение:  

     Возвращает значение выражения, рассчитанное из строки параметра. 
  

     Параметры: 

     <Строка> - строка, содержащая выражение на языке 2с.

    1.4.5.28. Активизировать(Activate)

      Русскоязычный синтаксис:

     Активизировать(<ИмяАтрибутаФормы>)

     Англоязычный синтаксис:

     Activate(<FormAttributeName>)

     Назначение:  

     Активизировать указанный атрибут формы. 
  

      Параметры: 

     <ИмяАтрибутаФормы> - строка, содержащая имя атрибута формы.

    1.4.5.29. ЗарегистрироватьСобытие(RegisterEvent)

     Русскоязычный синтаксис:

     ЗарегистрироватьСобытие(<ИмяСобытия>)

     Англоязычный синтаксис:

     RegisterEvent(<EventName>)

     Назначение:  

     Регистрирует в системе событие. 
  

      Параметры: 

     <ИмяСобытия> - строка, содержащая имя события.

    1.4.5.30. ВызватьСобытие(NotifyEvent)

     Русскоязычный синтаксис:

     ВызватьСобытие(<ИмяСобытия>[,<Пар1>]...[,<Пар7>])

     Англоязычный синтаксис:

     NotifyEvent(<EventName>[,<Par1>]...[,<Par7>])

     Назначение:  

     Вызывает ранее зарегистрированное в системе событие. 
  

      Параметры: 

     <ИмяСобытия> - строка, содержащая имя события.

     <Пар1>...<Пар7> - параметры, используемые обработчиками.   

    1.4.5.31. ПодписатьсяНаСобытие(SubscribeOnEvent)

     Русскоязычный синтаксис:

     ПодписатьсяНаСобытие(<ИмяСобытия>,<ИмяОбработчика>,<ФлагОшибки>,<Очередность>)

     Англоязычный синтаксис:

     SubscribeEvent(<EventName><ProcessorName>,<ErrorFlag>,<Severity>)

     Назначение:  

     Подписывает функцию-обработчик события. Возвращает 1, если подписка прошла удачно, 0 - если неудачно 
  

      Параметры: 

     <ИмяСобытия> - строка, содержащая имя события.

     <ИмяОбработчика> - имя функции текущего модуля, которая будет вызываться на исполнение при наступлении события.   

     <ФлагОшибки> - не используется

     <Очередность> - числовой параметр, от 0 до 100, позволяющий определить порядок вызова обработчиков при наступлении события. используемые обработчиками. Обработчики с меньшим значением параметра вызываются первыми. Значение по умолчанию - 50.