Поделиться через

Update-FormatData

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

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

Синтаксис

Update-FormatData
      [[-AppendPath] <String[]>]
      [-PrependPath <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Описание

Командлет Update-FormatData перезагрузит данные форматирования из файлов форматирования в текущий сеанс. Этот командлет позволяет обновить данные форматирования без перезапуска PowerShell.

Без параметров Update-FormatData перезагрузит файлы форматирования, загруженные ранее. Параметры Update-FormatData можно использовать для добавления новых файлов форматирования в сеанс.

Файлы форматирования — это текстовые файлы в формате XML с расширением имени файла format.ps1xml. Данные форматирования в файлах определяют отображение объектов Microsoft .NET Framework в сеансе.

При запуске PowerShell загружает данные формата из исходного кода PowerShell. Однако можно создать пользовательские файлы format.ps1xml для обновления форматирования в текущем сеансе. Вы можете использовать Update-FormatData для перезагрузки данных форматирования в текущий сеанс без перезапуска PowerShell. Это полезно при добавлении или изменении файла форматирования, но не требуется прерывать сеанс.

Дополнительные сведения о форматировании файлов в PowerShell см. в about_Format.ps1xml.

Примеры

Пример 1. Перезагрузить ранее загруженные файлы форматирования

Update-FormatData

Эта команда перезагрузит файлы форматирования, загруженные ранее.

Пример 2. Перезагрузить файлы форматирования и файлы трассировки и форматирования журнала

Update-FormatData -AppendPath "trace.format.ps1xml, log.format.ps1xml"

Эта команда перезагрузит файлы форматирования в сеанс, включая два новых файла, Trace.format.ps1xml и Log.format.ps1xml.

Так как команда использует параметр AppendPath, данные форматирования в новых файлах загружаются после форматирования данных из встроенных файлов.

Используется параметр AppendPath, так как новые файлы содержат данные форматирования для объектов, на которые не ссылаются встроенные файлы.

Пример 3. Изменение файла форматирования и его перезагрузка

Update-FormatData -PrependPath "c:\test\NewFiles.format.ps1xml"

# Edit the NewFiles.format.ps1 file.

Update-FormatData

В этом примере показано, как перезагрузить файл форматирования после изменения.

Первая команда добавляет файл NewFiles.format.ps1xml в сеанс. Он использует параметр PrependPath, так как файл содержит данные форматирования для объектов, на которые ссылаются встроенные файлы.

После добавления файла NewFiles.format.ps1xml и тестирования его в этих сеансах автор редактирует файл.

Вторая команда использует командлет Update-FormatData для перезагрузки файлов форматирования. Так как файл NewFiles.format.ps1xml был загружен ранее, Update-FormatData автоматически перезагрузит его без использования параметров.

Параметры

-AppendPath

Указывает файлы форматирования, которые этот командлет добавляет в сеанс. Файлы загружаются после загрузки встроенных файлов форматирования PowerShell.

При форматировании объектов .NET PowerShell использует первое определение форматирования, которое он находит для каждого типа .NET. Если вы используете параметр AppendPath, PowerShell выполняет поиск данных из встроенных файлов, прежде чем столкнуться с добавляющимися данными форматирования.

Используйте этот параметр для добавления файла, который форматирует объект .NET, который не ссылается в встроенных файлах форматирования.

Тип:String[]
Aliases:PSPath, Path
Position:0
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-PrependPath

Указывает файлы форматирования, которые этот командлет добавляет в сеанс. Файлы загружаются до загрузки встроенных файлов форматирования PowerShell.

При форматировании объектов .NET PowerShell использует первое определение форматирования, которое он находит для каждого типа .NET. Если вы используете параметр PrependPath, PowerShell выполняет поиск данных из добавляемых файлов, прежде чем столкнуться с данными форматирования из встроенных файлов.

Используйте этот параметр для добавления файла, который форматирует объект .NET, на который также ссылается встроенные файлы форматирования.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

String

Можно передать строку, содержащую путь добавления к этому командлету.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Примечания

  • Update-FormatData также обновляет данные форматирования для команд в сеансе, импортированных из модулей. Если файл форматирования для модуля изменяется, можно выполнить команду Update-FormatData, чтобы обновить данные форматирования для импортированных команд. Вам не нужно снова импортировать модуль.