Skip to content

Commit b54dc28

Browse files
SteveL-MSFTsdwheeler
authored andcommitted
Update get-culture doc for new parameters (#4069)
* update doc for new parameters * Update Get-Culture.md
1 parent 5b0a125 commit b54dc28

File tree

1 file changed

+90
-13
lines changed

1 file changed

+90
-13
lines changed

reference/6/Microsoft.PowerShell.Utility/Get-Culture.md

Lines changed: 90 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,43 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: Microsoft.PowerShell.Utility
6-
ms.date: 06/09/2017
6+
ms.date: 03/28/2019
77
online version: http://go.microsoft.com/fwlink/?LinkId=821779
88
schema: 2.0.0
99
title: Get-Culture
1010
---
11+
1112
# Get-Culture
1213

1314
## SYNOPSIS
1415
Gets the current culture set in the operating system.
1516

1617
## SYNTAX
1718

19+
### CurrentCulture (Default)
20+
21+
```
22+
Get-Culture [-NoUserOverrides] [<CommonParameters>]
23+
```
24+
25+
### Name
26+
27+
```
28+
Get-Culture [-Name <String[]>] [-NoUserOverrides] [<CommonParameters>]
29+
```
30+
31+
### ListAvailable
32+
1833
```
19-
Get-Culture [<CommonParameters>]
34+
Get-Culture [-ListAvailable] [<CommonParameters>]
2035
```
2136

2237
## DESCRIPTION
2338

24-
The **Get-Culture** cmdlet gets information about the current culture settings.
39+
The `Get-Culture` cmdlet gets information about the current culture settings.
2540
This includes information about the current language settings on the system, such as the keyboard layout, and the display format of items such as numbers, currency, and dates.
2641

27-
You can also use the Get-UICulture cmdlet, which gets the current user interface culture on the system, and the [Set-Culture](https://go.microsoft.com/fwlink/?LinkID=242258) cmdlet in the International module.
42+
You can also use the `Get-UICulture` cmdlet, which gets the current user interface culture on the system, and the [Set-Culture](/powershell/module/international/set-culture?view=win10-ps) cmdlet in the International module.
2843
The user-interface (UI) culture determines which text strings are used for user interface elements, such as menus and messages.
2944

3045
## EXAMPLES
@@ -106,25 +121,87 @@ The first command uses the **Get-Culture** cmdlet to get the current culture set
106121
It stores the resulting culture object in the $C variable.
107122

108123
The second command displays all of the properties of the culture object.
109-
It uses a pipeline operator (|) to send the culture object in $C to the Format-List cmdlet.
110-
It uses the *Property* parameter to display all (*) properties of the object.
124+
It uses a pipeline operator (|) to send the culture object in `$C` to the `Format-List` cmdlet.
125+
It uses the **Property** parameter to display all (\*) properties of the object.
111126
This command can be abbreviated as `$c | fl *`.
112127

113128
The remaining commands explore the properties of the culture object by using dot notation to display the values of the object properties.
114129
You can use this notation to display the value of any property of the object.
115130

116-
The third command uses dot notation to display the value of the Calendar property of the culture object.
131+
The third command uses dot notation to display the value of the **Calendar** property of the culture object.
117132

118-
The fourth command uses dot notation to display the value of the DataTimeFormat property of the culture object.
133+
The fourth command uses dot notation to display the value of the **DataTimeFormat** property of the culture object.
119134

120135
Many object properties have properties.
121-
The fifth command uses dot notation to display the value of the FirstDayOfWeek property of the DateTimeFormat property.
136+
The fifth command uses dot notation to display the value of the **FirstDayOfWeek** property of the **DateTimeFormat** property.
137+
138+
### Example 3: Get a specific culture
139+
140+
Get the CultureInfo object for English in the United States.
141+
142+
```powershell
143+
Get-Culture -Name en-US
144+
```
145+
146+
```output
147+
LCID Name DisplayName
148+
---- ---- -----------
149+
1033 en-US English (United States)
150+
```
122151

123152
## PARAMETERS
124153

154+
### -ListAvailable
155+
156+
Retrieves all cultures supported by the current operating system.
157+
158+
```yaml
159+
Type: SwitchParameter
160+
Parameter Sets: ListAvailable
161+
Aliases:
162+
163+
Required: False
164+
Position: Named
165+
Default value: None
166+
Accept pipeline input: False
167+
Accept wildcard characters: False
168+
```
169+
170+
### -Name
171+
172+
Retrieve a specific culture based on the name.
173+
174+
```yaml
175+
Type: String[]
176+
Parameter Sets: Name
177+
Aliases:
178+
179+
Required: False
180+
Position: Named
181+
Default value: None
182+
Accept pipeline input: True (ByValue)
183+
Accept wildcard characters: False
184+
```
185+
186+
### -NoUserOverrides
187+
188+
Ignore user changes for current culture.
189+
190+
```yaml
191+
Type: SwitchParameter
192+
Parameter Sets: CurrentCulture, Name
193+
Aliases:
194+
195+
Required: False
196+
Position: Named
197+
Default value: None
198+
Accept pipeline input: False
199+
Accept wildcard characters: False
200+
```
201+
125202
### CommonParameters
126203
127-
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).
204+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
128205
129206
## INPUTS
130207
@@ -136,14 +213,14 @@ You cannot pipe input to this cmdlet.
136213
137214
### System.Globalization.CultureInfo
138215
139-
**Get-Culture** returns an object that represents the current culture.
216+
`Get-Culture` returns an object that represents the current culture.
140217

141218
## NOTES
142219

143-
You can also use the $PsCulture and $PsUICulture variables. The $PsCulture variable stores the name of the current culture and the $PsUICulture variable stores the name of the current UI culture.
220+
You can also use the `$PsCulture` and `$PsUICulture` variables. The `$PsCulture` variable stores the name of the current culture and the `$PsUICulture` variable stores the name of the current UI culture.
144221

145222
## RELATED LINKS
146223

147224
[Set-Culture](/powershell/module/international/set-culture?view=win10-ps)
148225

149-
[Get-UICulture](Get-UICulture.md)
226+
[Get-UICulture](Get-UICulture.md)

0 commit comments

Comments
 (0)