PowerShell/docs/check-xml-file.md
2023-12-07 20:24:45 +01:00

90 lines
2.3 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

*check-xml-file.ps1*
================
This PowerShell script checks the given XML file for validity.
Parameters
----------
```powershell
PS> ./check-xml-file.ps1 [[-path] <String>] [<CommonParameters>]
-path <String>
Specifies the path to the XML file to check
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./check-xml-file.ps1 myfile.xml
Valid XML in 'myfile.xml'
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Verifies the given XML file
.DESCRIPTION
This PowerShell script checks the given XML file for validity.
.PARAMETER path
Specifies the path to the XML file to check
.EXAMPLE
PS> ./check-xml-file.ps1 myfile.xml
✔️ Valid XML in 'myfile.xml'
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$path = "")
try {
if ($path -eq "" ) { $path = Read-Host "Enter path to XML file" }
$XmlFile = Get-Item $path
# Perform the XSD Validation
$script:ErrorCount = 0
$ReaderSettings = New-Object -TypeName System.Xml.XmlReaderSettings
$ReaderSettings.ValidationType = [System.Xml.ValidationType]::Schema
$ReaderSettings.ValidationFlags = [System.Xml.Schema.XmlSchemaValidationFlags]::ProcessInlineSchema -bor [System.Xml.Schema.XmlSchemaValidationFlags]::ProcessSchemaLocation
$ReaderSettings.add_ValidationEventHandler({ $script:ErrorCount++ })
$Reader = [System.Xml.XmlReader]::Create($XmlFile.FullName, $ReaderSettings)
while ($Reader.Read()) { }
$Reader.Close()
if ($script:ErrorCount -gt 0) {
throw "Invalid XML in '$path'"
}
"✔️ Valid XML in '$path'"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of check-xml-file.ps1 as of 12/07/2023 20:24:16)*