Метод Session.FormatRecord

Метод FormatRecord объекта Session возвращает форматированную строку из шаблона и данных записи.

Синтаксис

Session.FormatRecord(
  record
)

Параметры

record

Обязательный объект Record , содержащий шаблон и данные для форматирования. Строка шаблона должна быть задана в поле 0, за которым следует все параметры данных, на которые ссылается ссылка.

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

Этот метод не возвращает значение.

Комментарии

Метод FormatRecord использует следующий процесс форматирования.

Отформатированные параметры заключаются в квадратные скобки [..]. Квадратные скобки могут быть итерированы, так как подстановки разрешаются изнутри.

Если часть строки заключена в фигурные скобки { } и не содержит квадратных скобок, часть остается без изменений, включая фигурные скобки.

Если часть строки заключена в фигурные скобки и содержит одно или несколько имен свойств, а все свойства найдены, текст (с разрешенными подстановками) отображается без фигурных скобок. Если какое-либо из свойств не найдено, весь текст в фигурных скобках и сами фигурные скобки удаляются.

Форматирование строк с помощью метода FormatRecord

1. Числовые параметры заменяются путем замены маркера значением соответствующего поля записи, при этом значения отсутствуют или значения NULL не создают текст.
2. Строка, которая возвращается, обрабатывается путем замены параметров, не являющихся записями, соответствующими значениями, как указано в следующих описаниях.
   • Если обнаружена подстрока формы "[propertyname]", она заменяется значением свойства .
   • При обнаружении подстроки формы "[%environmentvariable]" значение переменной среды подставляется.
   • Если подстрока формы [#filekey] найдена, она заменяется полным путем к файлу со значением filekey , используемым в качестве ключа в таблице File. Значение [#filekey] остается пустым и не заменяется путем, пока установщик не запустит действия CostInitialize, FileCost и CostFinalize. Значение [#filekey] зависит от состояния установки компонента, которому принадлежит файл. Если компонент выполняется из источника, значением является путь к исходному расположению файла. Если компонент запускается локально, значением является путь к целевому расположению файла после установки. Если компонент отсутствует, путь пустой. Дополнительные сведения о проверке состояния установки компонентов см. в разделе Проверка установки компонентов, компонентов, файлов.
   • Если подстрока формы [$componentkey] найдена, она заменяется каталогом установки компонента со значением componentkey , используемым в качестве ключа в таблице Component. Значение [$componentkey] остается пустым и не заменяется каталогом, пока установщик не запустит действия CostInitialize, FileCost и CostFinalize. Значение [$componentkey] зависит от состояния установки компонента. Если компонент выполняется из источника, значением является исходный каталог файла. Если компонент запускается локально, значением будет целевой каталог после установки. Если компонент отсутствует, значение остается пустым. Дополнительные сведения о проверке состояния установки компонентов см. в разделе Проверка установки компонентов, компонентов, файлов.
   • Если подстрока формы "[\c]" найдена, она заменяется символом без дальнейшей обработки. Сохраняется только первый символ после обратной косой черты; все остальное удаляется.

Требования

Требование	Значение
Версия	Установщик Windows 5.0 в Windows Server 2012, Windows 8, Windows Server 2008 R2 или Windows 7. Установщик Windows 4.0 или Установщик Windows 4.5 в Windows Server 2008 или Windows Vista. Установщик Windows в Windows Server 2003 или Windows XP
DLL	Msi.dll
IID	IID_ISession определяется как 000C109E-0000-0000-C000-0000000000046

См. также раздел

Форматированные

Типы данных столбцов