Repository navigation
Expand file tree
/
Copy pathGet-PSMDHelp.ps1
More file actions
208 lines (159 loc) · 9.01 KB
/
Copy pathGet-PSMDHelp.ps1
File metadata and controls
208 lines (159 loc) · 9.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
Function Get-PSMDHelp
{
<#
.SYNOPSIS
Displays localized information about Windows PowerShell commands and concepts.
.DESCRIPTION
The Get-PSMDHelp function is a wrapper around get-help that allows localizing help queries.
This is especially useful when developing modules with help in multiple languages.
.PARAMETER Category
Displays help only for items in the specified category and their aliases. Valid values are Alias, Cmdlet,
Function, Provider, Workflow, and HelpFile. Conceptual topics are in the HelpFile category.
.PARAMETER Component
Displays commands with the specified component value, such as "Exchange." Enter a component name. Wildcards are permitted.
This parameter has no effect on displays of conceptual ("About_") help.
.PARAMETER Detailed
Adds parameter descriptions and examples to the basic help display.
This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help.
.PARAMETER Examples
Displays only the name, synopsis, and examples. To display only the examples, type "(Get-PSMDHelpEx <cmdlet-name>).Examples".
This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help.
.PARAMETER Full
Displays the entire help topic for a cmdlet, including parameter descriptions and attributes, examples, input and output object types, and additional notes.
This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help.
.PARAMETER Functionality
Displays help for items with the specified functionality. Enter the functionality. Wildcards are permitted.
This parameter has no effect on displays of conceptual ("About_") help.
.PARAMETER Name
Gets help about the specified command or concept. Enter the name of a cmdlet, function, provider, script, or
workflow, such as "Get-Member", a conceptual topic name, such as "about_Objects", or an alias, such as "ls".
Wildcards are permitted in cmdlet and provider names, but you cannot use wildcards to find the names of
function help and script help topics.
To get help for a script that is not located in a path that is listed in the Path environment variable, type
the path and file name of the script .
If you enter the exact name of a help topic, Get-Help displays the topic contents. If you enter a word or word
pattern that appears in several help topic titles, Get-Help displays a list of the matching titles. If you
enter a word that does not match any help topic titles, Get-Help displays a list of topics that include that
word in their contents.
The names of conceptual topics, such as "about_Objects", must be entered in English, even in non-English versions of Windows PowerShell.
.PARAMETER Language
Set the language of the help returned. Use 5-digit language codes such as "en-us" or "de-de".
Note: If PowerShell does not have help in the language specified, it will either return nothing or default back to English
.PARAMETER SetLanguage
Sets the language of the current and all subsequent help queries. Use 5-digit language codes such as "en-us" or "de-de".
Note: If PowerShell does not have help in the language specified, it will either return nothing or default back to English
.PARAMETER Online
Displays the online version of a help topic in the default Internet browser. This parameter is valid only for
cmdlet, function, workflow and script help topics. You cannot use the Online parameter in Get-Help commands in
a remote session.
For information about supporting this feature in help topics that you write, see about_Comment_Based_Help
(http://go.microsoft.com/fwlink/?LinkID=144309), and "Supporting Online Help"
(http://go.microsoft.com/fwlink/?LinkID=242132), and "How to Write Cmdlet Help"
(http://go.microsoft.com/fwlink/?LinkID=123415) in the MSDN (Microsoft Developer Network) library.
.PARAMETER Parameter
Displays only the detailed descriptions of the specified parameters. Wildcards are permitted.
This parameter has no effect on displays of conceptual ("About_") help.
.PARAMETER Path
Gets help that explains how the cmdlet works in the specified provider path. Enter a Windows PowerShell provider path.
This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the
specified Windows PowerShell provider path. This parameter is effective only for help about a provider cmdlet
and only when the provider includes a custom version of the provider cmdlet help topic in its help file. To
use this parameter, install the help file for the module that includes the provider.
To see the custom cmdlet help for a provider path, go to the provider path location and enter a Get-Help
command or, from any path location, use the Path parameter of Get-Help to specify the provider path. You can
also find custom cmdlet help online in the provider help section of the help topics. For example, you can find
help for the New-Item cmdlet in the Wsman:\*\ClientCertificate path
(http://go.microsoft.com/fwlink/?LinkID=158676).
For more information about Windows PowerShell providers, see about_Providers
(http://go.microsoft.com/fwlink/?LinkID=113250).
.PARAMETER Role
Displays help customized for the specified user role. Enter a role. Wildcards are permitted.
Enter the role that the user plays in an organization. Some cmdlets display different text in their help files
based on the value of this parameter. This parameter has no effect on help for the core cmdlets.
.PARAMETER ShowWindow
Displays the help topic in a window for easier reading. The window includes a "Find" search feature and a
"Settings" box that lets you set options for the display, including options to display only selected sections
of a help topic.
The ShowWindow parameter supports help topics for commands (cmdlets, functions, CIM commands, workflows,
scripts) and conceptual "About" topics. It does not support provider help.
This parameter is introduced in Windows PowerShell 3.0.
.EXAMPLE
PS C:\> Get-PSMDHelp Get-Help "en-us" -Detailed
Gets the detailed help text of Get-Help in English
#>
[Alias('hex')]
[CmdletBinding(DefaultParameterSetName = "AllUsersView")]
Param (
[Parameter(ParameterSetName = "Parameters", Mandatory = $true)]
[System.String]
$Parameter,
[Parameter(ParameterSetName = "Online", Mandatory = $true)]
[System.Management.Automation.SwitchParameter]
$Online,
[Parameter(ParameterSetName = "ShowWindow", Mandatory = $true)]
[System.Management.Automation.SwitchParameter]
$ShowWindow,
[Parameter(ParameterSetName = "AllUsersView")]
[System.Management.Automation.SwitchParameter]
$Full,
[Parameter(ParameterSetName = "DetailedView", Mandatory = $true)]
[System.Management.Automation.SwitchParameter]
$Detailed,
[Parameter(ParameterSetName = "Examples", Mandatory = $true)]
[System.Management.Automation.SwitchParameter]
$Examples,
[ValidateSet("Alias", "Cmdlet", "Provider", "General", "FAQ", "Glossary", "HelpFile", "ScriptCommand", "Function", "Filter", "ExternalScript", "All", "DefaultHelp", "Workflow", "DscResource", "Class", "Configuration")]
[System.String[]]
$Category,
[System.String[]]
$Component,
[Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)]
[System.String]
$Name,
[Parameter(Position = 1)]
[System.String]
$Language,
[System.String]
$SetLanguage,
[System.String]
$Path,
[System.String[]]
$Functionality,
[System.String[]]
$Role
)
Begin
{
if (Test-PSFParameterBinding -ParameterName "SetLanguage") { $script:set_language = $SetLanguage }
if (Test-PSFParameterBinding -ParameterName "Language")
{
try { [System.Threading.Thread]::CurrentThread.CurrentUICulture = $Language }
catch { Write-PSFMessage -Level Warning -Message "Failed to set language" -ErrorRecord $_ -Tag 'fail','language' }
}
elseif ($script:set_language)
{
try { [System.Threading.Thread]::CurrentThread.CurrentUICulture = $script:set_language }
catch { Write-PSFMessage -Level Warning -Message "Failed to set language" -ErrorRecord $_ -Tag 'fail', 'language' }
}
# Prepare Splat for splatting a steppable pipeline
$splat = $PSBoundParameters | ConvertTo-PSFHashtable -Exclude Language, SetLanguage
try
{
$wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand('Get-Help', [System.Management.Automation.CommandTypes]::Cmdlet)
$scriptCmd = { & $wrappedCmd @splat }
$steppablePipeline = $scriptCmd.GetSteppablePipeline()
$steppablePipeline.Begin($PSCmdlet)
}
catch { throw }
}
Process
{
try { $steppablePipeline.Process($_) }
catch { throw }
}
End
{
try { $steppablePipeline.End() }
catch { throw }
}
}