PowerShell/docs/check-xml-file.md

88 lines
2.2 KiB
Markdown
Raw Normal View History

2024-01-25 13:37:12 +01:00
Script: *check-xml-file.ps1*
========================
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script checks the given XML file for validity.
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-12-07 20:24:45 +01:00
PS> ./check-xml-file.ps1 [[-path] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2023-12-07 20:24:45 +01:00
-path <String>
2024-01-25 13:31:10 +01:00
Specifies the path to the XML file
2021-11-08 21:36:42 +01:00
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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2023-12-07 20:24:45 +01:00
PS> ./check-xml-file.ps1 myfile.xml
2024-01-25 13:31:10 +01:00
✔️ Valid XML in 📄myfile.xml
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2024-01-25 13:31:10 +01:00
Verifies an XML file
2022-11-17 20:02:26 +01:00
.DESCRIPTION
This PowerShell script checks the given XML file for validity.
2023-12-07 20:24:45 +01:00
.PARAMETER path
2024-01-25 13:31:10 +01:00
Specifies the path to the XML file
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-12-07 20:24:45 +01:00
PS> ./check-xml-file.ps1 myfile.xml
2024-01-25 13:31:10 +01:00
✔️ Valid XML in 📄myfile.xml
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-12-07 20:24:45 +01:00
param([string]$path = "")
2022-11-17 20:02:26 +01:00
try {
2023-12-07 20:24:45 +01:00
if ($path -eq "" ) { $path = Read-Host "Enter path to XML file" }
2022-11-17 20:02:26 +01:00
2023-12-07 20:24:45 +01:00
$XmlFile = Get-Item $path
2022-11-17 20:02:26 +01:00
# Perform the XSD Validation
2023-12-07 20:24:45 +01:00
$script:ErrorCount = 0
2022-11-17 20:02:26 +01:00
$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()
2024-01-25 13:31:10 +01:00
if ($script:ErrorCount -gt 0) { throw "Invalid XML" }
2022-11-17 20:02:26 +01:00
2024-01-25 13:31:10 +01:00
"✔️ Valid XML in 📄$path"
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
2024-01-25 13:31:10 +01:00
"⚠️ $($Error[0]) in 📄$path"
2022-11-17 20:02:26 +01:00
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2024-01-25 13:58:49 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of check-xml-file.ps1 as of 01/25/2024 13:58:37)*