Supporting -Online

Supporting -Online Supporting -Online

To support the Online parameter of Get-Help you need to defined by the HelpUri property of the CmdletBinding() attribute for your function. The value of this property is a URL that points to the webpage containing the documentation. If you create MAML-based help, it also needs to be added to the XML file.

Examples

Script-based example:

1
2
3
4
5
6
7
8
9
function Verb-Noun
{
    [CmdletBinding(HelpURI=<URI>)]

    Param ($Parameter1)
    Begin{}
    Process{}
    End{}
}

C# example for a compiled cmdlet:

1
2
3
4
5
6
7
[Cmdlet(VerbsCommunications.Write, "Output",
        HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097117",
        RemotingCapability = RemotingCapability.None)]
public sealed class WriteOutputCommand : PSCmdlet
{
    ...
}

For more information, see the following articles: