|
| 1 | +--- |
| 2 | +external help file: System.Management.Automation.dll-Help.xml |
| 3 | +Module Name: Microsoft.PowerShell.Core |
| 4 | +online version: https://go.microsoft.com/fwlink/?LinkID=2096483 |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Get-Help |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +{{ Fill in the Synopsis }} |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +### AllUsersView (Default) |
| 16 | +``` |
| 17 | +Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Full] [-Component <String[]>] |
| 18 | + [-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +### DetailedView |
| 22 | +``` |
| 23 | +Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Detailed] [-Component <String[]>] |
| 24 | + [-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>] |
| 25 | +``` |
| 26 | + |
| 27 | +### Examples |
| 28 | +``` |
| 29 | +Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Examples] [-Component <String[]>] |
| 30 | + [-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>] |
| 31 | +``` |
| 32 | + |
| 33 | +### Parameters |
| 34 | +``` |
| 35 | +Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] -Parameter <String[]> |
| 36 | + [-Component <String[]>] [-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>] |
| 37 | +``` |
| 38 | + |
| 39 | +### Online |
| 40 | +``` |
| 41 | +Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Component <String[]>] |
| 42 | + [-Functionality <String[]>] [-Role <String[]>] [-Online] [<CommonParameters>] |
| 43 | +``` |
| 44 | + |
| 45 | +### ShowWindow |
| 46 | +``` |
| 47 | +Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Component <String[]>] |
| 48 | + [-Functionality <String[]>] [-Role <String[]>] [-ShowWindow] [<CommonParameters>] |
| 49 | +``` |
| 50 | + |
| 51 | +## DESCRIPTION |
| 52 | +{{ Fill in the Description }} |
| 53 | + |
| 54 | +## EXAMPLES |
| 55 | + |
| 56 | +### Example 1 |
| 57 | +```powershell |
| 58 | +PS C:\> {{ Add example code here }} |
| 59 | +``` |
| 60 | + |
| 61 | +{{ Add example description here }} |
| 62 | + |
| 63 | +## PARAMETERS |
| 64 | + |
| 65 | +### -Category |
| 66 | +{{ Fill Category Description }} |
| 67 | + |
| 68 | +```yaml |
| 69 | +Type: String[] |
| 70 | +Parameter Sets: (All) |
| 71 | +Aliases: |
| 72 | +Accepted values: Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, DscResource, Class, Configuration |
| 73 | + |
| 74 | +Required: False |
| 75 | +Position: Named |
| 76 | +Default value: None |
| 77 | +Accept pipeline input: False |
| 78 | +Accept wildcard characters: False |
| 79 | +``` |
| 80 | +
|
| 81 | +### -Component |
| 82 | +{{ Fill Component Description }} |
| 83 | +
|
| 84 | +```yaml |
| 85 | +Type: String[] |
| 86 | +Parameter Sets: (All) |
| 87 | +Aliases: |
| 88 | + |
| 89 | +Required: False |
| 90 | +Position: Named |
| 91 | +Default value: None |
| 92 | +Accept pipeline input: False |
| 93 | +Accept wildcard characters: False |
| 94 | +``` |
| 95 | +
|
| 96 | +### -Detailed |
| 97 | +{{ Fill Detailed Description }} |
| 98 | +
|
| 99 | +```yaml |
| 100 | +Type: SwitchParameter |
| 101 | +Parameter Sets: DetailedView |
| 102 | +Aliases: |
| 103 | + |
| 104 | +Required: True |
| 105 | +Position: Named |
| 106 | +Default value: None |
| 107 | +Accept pipeline input: False |
| 108 | +Accept wildcard characters: False |
| 109 | +``` |
| 110 | +
|
| 111 | +### -Examples |
| 112 | +{{ Fill Examples Description }} |
| 113 | +
|
| 114 | +```yaml |
| 115 | +Type: SwitchParameter |
| 116 | +Parameter Sets: Examples |
| 117 | +Aliases: |
| 118 | + |
| 119 | +Required: True |
| 120 | +Position: Named |
| 121 | +Default value: None |
| 122 | +Accept pipeline input: False |
| 123 | +Accept wildcard characters: False |
| 124 | +``` |
| 125 | +
|
| 126 | +### -Full |
| 127 | +{{ Fill Full Description }} |
| 128 | +
|
| 129 | +```yaml |
| 130 | +Type: SwitchParameter |
| 131 | +Parameter Sets: AllUsersView |
| 132 | +Aliases: |
| 133 | + |
| 134 | +Required: False |
| 135 | +Position: Named |
| 136 | +Default value: None |
| 137 | +Accept pipeline input: False |
| 138 | +Accept wildcard characters: False |
| 139 | +``` |
| 140 | +
|
| 141 | +### -Functionality |
| 142 | +{{ Fill Functionality Description }} |
| 143 | +
|
| 144 | +```yaml |
| 145 | +Type: String[] |
| 146 | +Parameter Sets: (All) |
| 147 | +Aliases: |
| 148 | + |
| 149 | +Required: False |
| 150 | +Position: Named |
| 151 | +Default value: None |
| 152 | +Accept pipeline input: False |
| 153 | +Accept wildcard characters: False |
| 154 | +``` |
| 155 | +
|
| 156 | +### -Name |
| 157 | +{{ Fill Name Description }} |
| 158 | +
|
| 159 | +```yaml |
| 160 | +Type: String |
| 161 | +Parameter Sets: (All) |
| 162 | +Aliases: |
| 163 | + |
| 164 | +Required: False |
| 165 | +Position: 0 |
| 166 | +Default value: None |
| 167 | +Accept pipeline input: True (ByPropertyName) |
| 168 | +Accept wildcard characters: False |
| 169 | +``` |
| 170 | +
|
| 171 | +### -Online |
| 172 | +{{ Fill Online Description }} |
| 173 | +
|
| 174 | +```yaml |
| 175 | +Type: SwitchParameter |
| 176 | +Parameter Sets: Online |
| 177 | +Aliases: |
| 178 | + |
| 179 | +Required: True |
| 180 | +Position: Named |
| 181 | +Default value: None |
| 182 | +Accept pipeline input: False |
| 183 | +Accept wildcard characters: False |
| 184 | +``` |
| 185 | +
|
| 186 | +### -Parameter |
| 187 | +{{ Fill Parameter Description }} |
| 188 | +
|
| 189 | +```yaml |
| 190 | +Type: String[] |
| 191 | +Parameter Sets: Parameters |
| 192 | +Aliases: |
| 193 | + |
| 194 | +Required: True |
| 195 | +Position: Named |
| 196 | +Default value: None |
| 197 | +Accept pipeline input: False |
| 198 | +Accept wildcard characters: False |
| 199 | +``` |
| 200 | +
|
| 201 | +### -Path |
| 202 | +{{ Fill Path Description }} |
| 203 | +
|
| 204 | +```yaml |
| 205 | +Type: String |
| 206 | +Parameter Sets: (All) |
| 207 | +Aliases: |
| 208 | + |
| 209 | +Required: False |
| 210 | +Position: Named |
| 211 | +Default value: None |
| 212 | +Accept pipeline input: False |
| 213 | +Accept wildcard characters: False |
| 214 | +``` |
| 215 | +
|
| 216 | +### -Role |
| 217 | +{{ Fill Role Description }} |
| 218 | +
|
| 219 | +```yaml |
| 220 | +Type: String[] |
| 221 | +Parameter Sets: (All) |
| 222 | +Aliases: |
| 223 | + |
| 224 | +Required: False |
| 225 | +Position: Named |
| 226 | +Default value: None |
| 227 | +Accept pipeline input: False |
| 228 | +Accept wildcard characters: False |
| 229 | +``` |
| 230 | +
|
| 231 | +### -ShowWindow |
| 232 | +{{ Fill ShowWindow Description }} |
| 233 | +
|
| 234 | +```yaml |
| 235 | +Type: SwitchParameter |
| 236 | +Parameter Sets: ShowWindow |
| 237 | +Aliases: |
| 238 | + |
| 239 | +Required: True |
| 240 | +Position: Named |
| 241 | +Default value: None |
| 242 | +Accept pipeline input: False |
| 243 | +Accept wildcard characters: False |
| 244 | +``` |
| 245 | +
|
| 246 | +### CommonParameters |
| 247 | +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). |
| 248 | +
|
| 249 | +## INPUTS |
| 250 | +
|
| 251 | +### System.String |
| 252 | +
|
| 253 | +## OUTPUTS |
| 254 | +
|
| 255 | +### System.Object |
| 256 | +## NOTES |
| 257 | +
|
| 258 | +## RELATED LINKS |
| 259 | +
|
| 260 | +[https://go.microsoft.com/fwlink/?LinkID=2096483](https://go.microsoft.com/fwlink/?LinkID=2096483) |
| 261 | +
|
0 commit comments