Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Close-OfficeYaml

Module
PSWriteOffice
Inputs
OfficeIMO.Yaml.YamlDocument
Source
CloseOfficeYamlCommand.cs:14 Edit on GitHub

Completes a live YAML document's lifetime without saving.

Syntax

Close-OfficeYaml
-Document <YamlDocument>
[<CommonParameters>]
#
Parameter set: Document

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Configuration Files and Data Conversion Guide

    Edit YAML and TOML without losing comments, read and write them as objects, and convert JSON, YAML, TOML, XML, CSV and Excel data from PowerShell.

  • YAML Documents Guide

    OfficeIMO.Yaml engine overview: lossless YAML editing, overlay merging, streaming and object serialization, with examples, options, limits and API links.

Examples

Discard pending changes.

Close-OfficeYaml -Document $document

Read a value and release the document.

$document = Open-OfficeYaml -Path ./values.yaml
(Get-OfficeYamlNode -Document $document -Select 'image.tag').Value
Close-OfficeYaml -Document $document

Parameters

-Document YamlDocument requiredpipeline: True (ByValue)
YAML document to close.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.