Export (0) Print
Expand All
Expand Minimize

Select-Xml

Updated: May 8, 2014

Applies To: Windows PowerShell 4.0

Select-Xml

Finds text in an XML string or document.

Syntax

Parameter Set: Xml
Select-Xml [-XPath] <String> [-Xml] <XmlNode[]> [-Namespace <Hashtable> ] [ <CommonParameters>]

Parameter Set: Content
Select-Xml [-XPath] <String> -Content <String[]> [-Namespace <Hashtable> ] [ <CommonParameters>]

Parameter Set: LiteralPath
Select-Xml [-XPath] <String> -LiteralPath <String[]> [-Namespace <Hashtable> ] [ <CommonParameters>]

Parameter Set: Path
Select-Xml [-XPath] <String> [-Path] <String[]> [-Namespace <Hashtable> ] [ <CommonParameters>]




Detailed Description

The Select-Xml cmdlet lets you use XPath queries to search for text in XML strings and documents. Enter an XPath query, and use the Content, Path, or Xml parameter to specify the XML to be searched.

Parameters

-Content<String[]>

Specifies a string that contains the XML to search. You can also pipe strings to Select-Xml.


Aliases

none

Required?

true

Position?

named

Default Value

None

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Namespace<Hashtable>

Specifies a hash table of the namespaces used in the XML. Use the format @{<namespaceName> = <namespaceValue>}.

When the XML uses the default namespace, which begins with "xmlns", use an arbitrary key for the namespace name. You cannot use "xmlns". In the XPath statement, prefix each node name with the namespace name and a colon, such as "//namespaceName:Node".


Aliases

none

Required?

false

Position?

named

Default Value

None

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Path<String[]>

Specifies the path and file names of the XML files to search. Wildcard characters are permitted.


Aliases

none

Required?

true

Position?

2

Default Value

None

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-XPath<String>

Specifies an XPath search query. The query language is case-sensitive. This parameter is required.


Aliases

none

Required?

true

Position?

1

Default Value

None

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Xml<XmlNode[]>

Specifies one or more XML nodes.

An XML document will be processed as a collection of XML nodes. If you pipe an XML document to Select-Xml, each document node will be searched separately as it comes through the pipeline.


Aliases

none

Required?

true

Position?

2

Default Value

None

Accept Pipeline Input?

true (ByPropertyName, ByValue)

Accept Wildcard Characters?

false

-LiteralPath<String[]>

Specifies the paths and file names of the XML files to search. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String or System.Xml.XmlNode

    You can pipe a path or XML node to Select-Xml.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.PowerShell.Commands.SelectXmlInfo

Notes

  • XPath is a standard language that is designed to identify parts of an XML document. For more information about the XPath language, see the "Selection Filters" section of the "Event Selection" topic in the MSDN (Microsoft Developer Network) library at http://go.microsoft.com/fwlink/?LinkId=143608. And, see "XPath Reference" in the MSDN library at http://go.microsoft.com/fwlink/?LinkId=143609.

Examples

-------------------------- EXAMPLE 1 --------------------------

This example gets the alias properties in the Types.ps1xml. (For information about this file, see about_Types.ps1xml.)

The first command saves the path to the Types.ps1xml file in the $Path variable.

The second command saves the XML path to the AliasProperty node in the $XPath variable.

The third command uses the Select-Xml cmdlet to get the AliasProperty nodes that are identified by the XPath statement from the Types.ps1xml file. The command uses a pipeline operator to send the AliasProperty nodes to the Select-Object cmdlet. The ExpandProperty parameter expands the Node object and returns its Name and ReferencedMemberName properties.

The result shows the Name and ReferencedMemberName of each alias property in the Types.ps1xml file. For example, there is a Count property that is an alias of the Length property.


PS C:\>  $Path = "$pshome\Types.ps1xml"
PS C:\>$XPath = "/Types/Type/Members/AliasProperty"
PS C:\>Select-Xml -Path $path -XPath $xpath | Select-Object -ExpandProperty Node
Name                 ReferencedMemberName
---- --------------------
Count Length
Name Key
Name ServiceName
RequiredServices ServicesDependedOn
ProcessName Name
Handles Handlecount
VM VirtualSize
WS WorkingSetSize
Name ProcessName
Handles Handlecount
VM VirtualMemorySize
WS WorkingSet
PM PagedMemorySize
NPM NonpagedSystemMemorySize
Name __Class
Namespace ModuleName

-------------------------- EXAMPLE 2 --------------------------

This example shows how to use the XML parameter to provide an XML document to the Select-Xml cmdlet.

The first command uses the Get-Content cmdlet to get the content of the Types.ps1xml file and save it in the $Types variable. The "[xml]" casts the variable as an XML object.

The second command uses the Select-Xml cmdlet to get the MethodName nodes in the Types.ps1xml file. The command uses the Xml parameter to specify the XML content in the $Types variable and the XPath parameter to specify the path to the MethodName node.


PS C:\> [xml]$Types = Get-Content $pshome\Types.ps1xml
PS C:\>Select-Xml -Xml $Types -XPath "//MethodName"

-------------------------- EXAMPLE 3 --------------------------

This example shows how to use the Select-Xml cmdlet to search the Windows PowerShell XML-based cmdlet help files. In this example, we'll search for the cmdlet name that serves as a title for each help file and the path to the help file.


 

The first command creates a hash table that represents the XML namespace that is used for the help files and saves it in the $Namespace variable.


PS C:\> $Namespace = @{command="http://schemas.microsoft.com/maml/dev/command/2004/10"; maml="http://schemas.microsoft.com/maml/2004/10"; dev="http://schemas.microsoft.com/maml/dev/2004/10"}

 

The second command saves the path to the help files in the $Path variable.

If there are no help files in this path on your computer, use the Update-Help cmdlet to download the help files. For more information about Updatable Help, see about_Updatable_Help ( http://go.microsoft.com/fwlink/?LinkId=235801).


PS C:\> $Path = "$pshome\en-us\*dll-Help.xml"

 

The third command uses the Select-Xml cmdlet to search the XML for cmdlet names by finding Command:Name element anywhere in the files. It saves the results in the $xml variable.

Select-Xml returns a SelectXmlInfo object that has a Node property, which is a System.Xml.XmlElement object. The Node property has an InnerXML property, which contains the actual XML that is retrieved.


PS C:\> $Xml = Select-Xml -Path $Path -Namespace $Namespace -XPath "//command:name"

 

The fourth command sends the XML in the $Xml variable to the Format-Table cmdlet. The Format-Table command uses a calculated property to get the Node.InnerXML property of each object in the $Xml variable, trim the white space before and after the text, and display it in the table, along with the path to the source file.


PS C:\> $Xml | Format-Table @{Label="Name"; Expression= {($_.node.innerxml).trim()}}, Path -AutoSize
                
Name Path
---- ----
Export-Counter C:\Windows\system32\WindowsPowerShell\v1.0\en-us\Microsoft.PowerShell.Commands.Diagnostics.dll-Help.xml
Get-Counter C:\Windows\system32\WindowsPowerShell\v1.0\en-us\Microsoft.PowerShell.Commands.Diagnostics.dll-Help.xml
Get-WinEvent C:\Windows\system32\WindowsPowerShell\v1.0\en-us\Microsoft.PowerShell.Commands.Diagnostics.dll-Help.xml
Import-Counter C:\Windows\system32\WindowsPowerShell\v1.0\en-us\Microsoft.PowerShell.Commands.Diagnostics.dll-Help.xml
Add-Computer C:\Windows\system32\WindowsPowerShell\v1.0\en-us\Microsoft.PowerShell.Commands.Management.dll-Help.xml
Add-Content C:\Windows\system32\WindowsPowerShell\v1.0\en-us\Microsoft.PowerShell.Commands.Management.dll-Help.xml
Checkpoint-Computer C:\Windows\system32\WindowsPowerShell\v1.0\en-us\Microsoft.PowerShell.Commands.Management.dll-Help.xml
...

-------------------------- EXAMPLE 4 --------------------------

This example shows two different ways to send XML to the Select-Xml cmdlet.


 

The first command saves a here-string that contains XML in the $xml variable. (For more information about here-strings, see about_Quoting_Rules.)


PS C:\> $xml = @"
<?xml version="1.0" encoding="utf-8"?>
<Book>
  <projects>
    <project name="Book1" date="2009-01-20">
      <editions>
        <edition language="English">En.Book1.com</edition>
        <edition language="German">Ge.Book1.Com</edition>
        <edition language="French">Fr.Book1.com</edition>
        <edition language="Polish">Pl.Book1.com</edition>
      </editions>
    </project>
  </projects>
</Book>
"@

 

The second command uses the Content parameter of Select-Xml to specify the XML in the $xml variable.


PS C:\> Select-Xml -Content $xml -XPath "//edition" | foreach {$_.node.InnerXML}
                
En.Book1.com
Ge.Book1.Com
Fr.Book1.com
Pl.Book1.com

 

The third command is equivalent to the second. It uses a pipeline operator (|) to send the XML in the $xml variable to the Select-Xml cmdlet.


PS C:\> $xml | Select-Xml -XPath "//edition" | foreach {$_.node.InnerXML}
                
En.Book1.com
Ge.Book1.Com
Fr.Book1.com
Pl.Book1.com

-------------------------- EXAMPLE 5 --------------------------

This example shows how to use the Select-Xml cmdlet with XML documents that use the default "xmlns" namespace. The example gets the titles of Windows PowerShell ISE user-created snippet files. For information about snippets, see New-IseSnippet.


 

The first command creates a hash table for the default namespace the that snippet XML files use and assigns it to the $SnippetNamespace variable. The hash table value is the XMLNS schema URI in the snippet XML. The hash table key name, "snip," is arbitrary. You can use any name that is not reserved, but you cannot use "xmlns."


PS C:\> $SnippetNamespace = @{snip="http://schemas.microsoft.com/PowerShell/Snippets"}

 

The second command uses the Select-Xml cmdlet to get the content of the Title element of each snippet. It uses the Path parameter to specify the Snippets directory and the Namespace parameter to specify the namespace in the $SnippetNamespace variable.

The value of the XPath parameter is the "snip" namespace key, a colon (:), and the name of the Title element.

The command uses a pipeline operator (|) to send each Node property that Select-Xml returns to the ForEach-Object cmdlet, which gets the title in the value of the InnerXml property of the node.


PS C:\> Select-Xml –Path $home\Documents\WindowsPowerShell\Snippets –Namespace $SnippetNamespace –XPath "//snip:Title" | foreach {$_.Node.Innerxml}

Related topics



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft