Get-FunctionFromScript.md

Get-FunctionFromScript

SYNOPSIS

Gets the functions and filters declared within a script block or a file

Script file

PowerShellScripts\Generate-ScriptMarkdownHelp.ps1

SYNTAX

File (Default)

Get-FunctionFromScript -File <String> [-OutputMetaData]

ScriptBlock

Get-FunctionFromScript [-ScriptBlock] <ScriptBlock> [-OutputMetaData]

DESCRIPTION

Gets the functions exactly as they are written within a script or file

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

Get-FunctionFromScript {
function foo() {
"foo"
}
function bar() {
"bar"
}
}

PARAMETERS

-ScriptBlock

The script block containing functions

Type: ScriptBlockParameter Sets: ScriptBlockAliases: Required: TruePosition: 1Default value: NoneAccept pipeline input: True (ByPropertyName)Accept wildcard characters: False

-File

A file containing functions

Type: StringParameter Sets: FileAliases: FullNameRequired: TruePosition: NamedDefault value: NoneAccept pipeline input: True (ByPropertyName)Accept wildcard characters: False

-OutputMetaData

If set, outputs the command metadatas

Type: SwitchParameterParameter Sets: (All)Aliases: Required: FalsePosition: NamedDefault value: FalseAccept pipeline input: FalseAccept wildcard characters: False

INPUTS

OUTPUTS

System.Management.Automation.ScriptBlock

System.Management.Automation.PSObject

NOTES

RELATED LINKS

http://powershellpipeworks.com/