Skip to content

Commit be3846e

Browse files
author
Sean Wheeler
committed
Merge branch 'staging' of https://github.com/MicrosoftDocs/PowerShell-Docs into staging
2 parents 387d4cc + 649360c commit be3846e

File tree

8 files changed

+798
-627
lines changed

8 files changed

+798
-627
lines changed

‎reference/3.0/Microsoft.PowerShell.Management/Get-ControlPanelItem.md

Lines changed: 95 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,56 @@
11
---
2-
ms.date: 06/09/2017
3-
schema: 2.0.0
4-
locale: en-us
5-
keywords: powershell,cmdlet
2+
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
3+
keywords: powershell,cmdlet
4+
locale: en-us
5+
Module Name: Microsoft.PowerShell.Management
6+
ms.date: 09/11/2019
67
online version: https://go.microsoft.com/fwlink/?linkid=219982
7-
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
8-
title: Get-ControlPanelItem
8+
schema: 2.0.0
9+
title: Get-ControlPanelItem
910
---
10-
1111
# Get-ControlPanelItem
12+
1213
## SYNOPSIS
1314
Gets control panel items.
15+
1416
## SYNTAX
1517

1618
### RegularName (Default)
19+
1720
```
1821
Get-ControlPanelItem [[-Name] <String[]>] [-Category <String[]>] [<CommonParameters>]
1922
```
2023

2124
### CanonicalName
25+
2226
```
2327
Get-ControlPanelItem -CanonicalName <String[]> [-Category <String[]>] [<CommonParameters>]
2428
```
2529

2630
## DESCRIPTION
27-
The **Get-ControlPanelItem** cmdlet gets control panel items on the local computer.
28-
You can use it to find control panel items by name, category, or description, even on systems that do not have a user interface.
2931

30-
**Get-ControlPanelItem** gets only the control panel items that can be opened on the system.
31-
On computers that do not have Control Panel or File Explorer, **Get-ControlPanelItem** gets only control panel items that can open without these components.
32+
The `Get-ControlPanelItem` cmdlet gets control panel items on the local computer. You can use it
33+
to find control panel items by name, category, or description, even on systems that do not have a
34+
user interface.
35+
36+
This cmdlet gets only the control panel items that can be opened on the system. On computers that do
37+
not have Control Panel or File Explorer, this cmdlet gets only control panel items that can open
38+
without these components.
39+
40+
This cmdlet was introduced in Windows PowerShell 3.0. It works only on Windows 8 and Windows Server
41+
2012 and newer.
3242

33-
This cmdlet is introduced in Windows PowerShell 3.0.
34-
It works only on Windows 8 and Windows Server 2012.
3543
## EXAMPLES
3644

3745
### Example 1: Get all control panel items
46+
47+
This command gets all control panel items on the local computer.
48+
49+
```powershell
50+
Get-ControlPanelItem
3851
```
39-
PS C:\> Get-ControlPanelItem
52+
53+
```Output
4054
Name CanonicalName Category Description
4155
---- ------------- -------- -----------
4256
Action Center Microsoft.ActionCenter {System and Security} Review recent messages and...
@@ -46,55 +60,75 @@ BitLocker Drive Encryption Microsoft.BitLockerDriveEn... {System and Security
4660
Color Management Microsoft.ColorManagement {All Control Panel Items} Change advanced color mana...
4761
Credential Manager Microsoft.CredentialManager {User Accounts} Manage your Windows Creden...
4862
Date and Time Microsoft.DateAndTime {Clock, Language, and Region} Set the date, time, and ti...
63+
...
4964
```
5065

51-
This command gets all control panel items on the local computer.
5266
### Example 2: Get control panel items by name
53-
```
54-
PS C:\> Get-ControlPanelItem -Name *program*, *app*
67+
68+
This example gets control panel items that have Program or App in their names.
69+
70+
```powershell
71+
Get-ControlPanelItem -Name "*Program*", "*App*"
5572
```
5673

57-
This command gets control panel items that have "program" or "app" in their names.
5874
### Example 3: Get control panel items by category
59-
```
60-
PS C:\> Get-ControlPanelItem -Category *security*
75+
76+
This command gets all control panel items in categories that have Security in their names.
77+
78+
```powershell
79+
Get-ControlPanelItem -Category "*Security*"
6180
```
6281

63-
This command gets all control panel items in categories that have "Security" in their names.
6482
### Example 4: Open a control panel item
83+
84+
This example opens the Windows Firewall control panel item on the local computer.
85+
86+
```powershell
87+
Get-ControlPanelItem -Name "Windows Firewall" | Show-ControlPanelItem
6588
```
66-
PS C:\> Get-ControlPanelItem -Name "Windows Firewall" | Show-ControlPanelItem
67-
```
6889

69-
This command opens the Windows Firewall control panel item on the local computer.
70-
It uses the **Get-ControlPanelItem** cmdlet to get the control panel item and the Show-ControlPanelItem cmdlet to open it.
90+
The `Get-ControlPanelItem` cmdlet gets the control panel item. The `Show-ControlPanelItem` cmdlet
91+
opens it.
92+
7193
### Example 5: Get control panel items on a remote computer
72-
```
73-
PS C:\> Invoke-Command -ComputerName Server01 {Get-ControlPanelItem -Name "BitLocker*" }
94+
95+
This example gets the BitLocker Drive Encryption control panel item on the Server01 remote computer.
96+
The `Invoke-Command` cmdlet runs the `Get-ControlPanelItem` cmdlet remotely.
97+
98+
```powershell
99+
Invoke-Command -ComputerName "Server01" {Get-ControlPanelItem -Name "BitLocker*" }
74100
```
75101

76-
This command gets the BitLocker Drive Encryption control panel item on the Server01 remote computer.
77-
It uses the Invoke-Command cmdlet to run the Get-ControlPanelItem cmdlet remotely.
78102
### Example 6: Search the descriptions of control panel items
103+
104+
This example searches the **Description** property of the control panel items to get only those that
105+
contain the name **Device**.
106+
107+
```powershell
108+
Get-ControlPanelItem | Where-Object {$_.Description -like "*Device*"}
79109
```
80-
PS C:\> Get-ControlPanelItem | Where-Object {$_.Description -like "*device*"}
81-
Name CanonicalName Category Description
82-
---- ------------- -------- -----------
83-
AutoPlay Microsoft.AutoPlay {Hardware} Change default settings fo...
84-
Devices and Printers Microsoft.DevicesAndPrinters {Hardware} View and manage devices, p...
85-
Sound Microsoft.Sound {Hardware} Configure your audio devic...
110+
111+
```Output
112+
Name CanonicalName Category Description
113+
---- ------------- -------- -----------
114+
AutoPlay Microsoft.AutoPlay {Hardware} Change default settings fo...
115+
Devices and Printers Microsoft.DevicesAndPrinters {Hardware} View and manage devices, p...
116+
Sound Microsoft.Sound {Hardware} Configure your audio devic...
86117
```
87118

88-
This command searches the **Description** property of the control panel item objects and gets only those that contain "device".
89-
The command uses the Get-ControlPanelItem cmdlet to get all control panel items and the Where-Object cmdlet to filter the items by the value of the **Description** property.
119+
The `Get-ControlPanelItem` cmdlet gets all control panel items. The `Where-Object` cmdlet filters
120+
the items by the value of the **Description** property.
121+
90122
## PARAMETERS
91123

92124
### -CanonicalName
93-
Gets control panel items with the specified canonical names or name patterns.
94-
Wildcards are permitted.
95-
If you enter multiple names, **Get-ControlPanelItem** gets control panel items that match any of the names, as though the items in the name list were separated by an "or" operator.
96125

97-
By default, **Get-ControlPanelItem** gets all control panel items in the system.
126+
Specifies, as a string array, the control panel items by their canonical names or name patterns that
127+
this cmdlet gets. Wildcards are permitted. If you enter multiple names, this cmdlet gets control
128+
panel items that match any of the names, as though the items in the name list were separated by an
129+
"or" operator.
130+
131+
By default, this cmdlet gets all control panel items in the system.
98132

99133
```yaml
100134
Type: String[]
@@ -103,17 +137,18 @@ Aliases:
103137

104138
Required: True
105139
Position: Named
106-
Default value: All control panel items
140+
Default value: None
107141
Accept pipeline input: False
108142
Accept wildcard characters: True
109143
```
110144
111145
### -Category
112-
Gets control panel items in the specified categories.
113-
Enter a category name or name pattern.
114-
Wildcards are permitted.
115-
If you enter multiple names, Get-ControlPanelItem gets control panel items that match any of the names, as though the items in the name list were separated by an "or" operator.
116-
By default, **Get-ControlPanelItem** gets all control panel items in the system.
146+
147+
Specifies, as a string array, the categories of the control panel items in the specified categories
148+
that this cmdlet gets. Enter a category name or name pattern. Wildcards are permitted. If you enter
149+
multiple names, this cmdlet gets control panel items that match any of the names, as though the
150+
items in the name list were separated by an "or" operator. By default, this cmdlet gets all control
151+
panel items in the system.
117152
118153
```yaml
119154
Type: String[]
@@ -122,44 +157,48 @@ Aliases:
122157

123158
Required: False
124159
Position: Named
125-
Default value: All control panel items
160+
Default value: None
126161
Accept pipeline input: False
127162
Accept wildcard characters: True
128163
```
129164
130165
### -Name
131-
Gets control panel items with the specified names or name patterns.
132-
Wildcards are permitted.
133-
You can also pipe a name or name pattern to the **Get-ControlPanelItem** cmdlet.
166+
167+
Specifies, as a string array, the names or name patterns of the control panel that this cmdlet gets.
168+
Wildcards are permitted. You can also pipe a name or name pattern to this cmdlet.
134169
135170
```yaml
136171
Type: String[]
137172
Parameter Sets: RegularName
138173
Aliases:
139174

140175
Required: False
141-
Position: 1
176+
Position: 0
142177
Default value: None
143178
Accept pipeline input: True (ByPropertyName, ByValue)
144179
Accept wildcard characters: True
145180
```
146181
147182
### CommonParameters
148-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
183+
184+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
185+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
186+
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
187+
149188
## INPUTS
150189
151190
### System.String
152-
You can pipe a name or name pattern to the Get-ControlPanelItem cmdlet.
191+
192+
You can pipe a name or name pattern to this cmdlet.
153193
154194
## OUTPUTS
155195
156196
### Microsoft.PowerShell.Commands.ControlPanelItem
197+
157198
This cmdlet gets control panel items on the local computer.
158199
159200
## NOTES
160201
161202
## RELATED LINKS
162203
163204
[Show-ControlPanelItem](Show-ControlPanelItem.md)
164-
165-

0 commit comments

Comments
 (0)