Show-RandomHelpAbout.ps1

• Description
  • Purpose
  • Detailed Description
  • Usage
  • Notes
  • Script
  • Download
  • Report Issues

Description

Purpose

Displays a random help topic from the about_* help files.

Detailed Description

The Show-RandomHelpAbout function displays a random help topic from the about_* help files. By default, the help topic is displayed in the console. If the -showWindow switch is specified, the help topic is displayed in a separate window.

Back to Top

Usage

Example 1

Show-RandomHelpAbout

Displays a random help topic in the console.

Example 2

Show-RandomHelpAbout -showWindow

Displays a random help topic in a separate window.

Back to Top

Notes

No additional notes.

Back to Top

Script

function Show-RandomHelpAbout {
    
    <#
    .SYNOPSIS
    Displays a random help topic from the about_* help files.
    
    .DESCRIPTION
    The Show-RandomHelpAbout function displays a random help topic from the about_* help files. By default, the help topic is displayed in the console. If the -showWindow switch is specified, the help topic is displayed in a separate window.
    
    .PARAMETER showWindow
    Displays the help topic in a separate window.
    
    .EXAMPLE
    Show-RandomHelpAbout
    
    Displays a random help topic in the console.
    
    .EXAMPLE
    Show-RandomHelpAbout -showWindow
    
    Displays a random help topic in a separate window.
    
    #>
    
    param (
        [Parameter(ValueFromPipeline = $True)]
        [switch]$showWindow
    )
    if ($showWindow) {
        Get-Random -input (Get-Help about*) | Get-Help -ShowWindow
    }
    else {
        Get-Random -input (Get-Help about*) | Get-Help
    }
}

Back to Top

Download

Please feel free to copy parts of the script or if you would like to download the entire script, simply click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.

Download

Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue

Back to Top

Back to UserAdminModule