FunctionInfo Class

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
Microsoft.WSMan.Runtime v7.0.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Provides information about a function that is stored in session state.

public ref class FunctionInfo : System::Management::Automation::CommandInfo
public class FunctionInfo : System.Management.Automation.CommandInfo
type FunctionInfo = class
    inherit CommandInfo
Public Class FunctionInfo
Inherits CommandInfo
Inheritance
Object
CommandInfo
FunctionInfo
Derived

Properties

CmdletBinding

Returns true if this function uses cmdlet binding mode for its parameters; otherwise returns false.
CommandType

Gets the type of the command

(Inherited from CommandInfo)
DefaultParameterSet

Gets the name of the default parameter set.
Returns null if this function doesn't use cmdlet parameter binding or if the default parameter set wasn't specified.
Definition

Gets the definition of the function which is the ToString() of the ScriptBlock that implements the function.
Description

Gets or sets the description associated with the function
HelpFile

Gets the help file path for the function.
Module

The module that defines this cmdlet. This will be null for commands that are not defined in the context of a module.

(Inherited from CommandInfo)
ModuleName

The module name of this command. It will be empty for commands not imported from either a module or snapin.

(Inherited from CommandInfo)
Name

Gets the name of the command.

(Inherited from CommandInfo)
Noun

Gets the noun of the function.
Options

Gets or sets the scope options for the function.
OutputType

The output type(s) is specified in the script block
Parameters

Return the parameters for this command.

(Inherited from CommandInfo)
ParameterSets

Gets the information about the parameters and parameter sets for this command.

(Inherited from CommandInfo)
RemotingCapability

The remoting capabilities of this cmdlet, when exposed in a context with ambient remoting.

(Inherited from CommandInfo)
ScriptBlock

Gets the ScriptBlock which is the implementation of the function
Source

Gets the source of the command (shown by default in Get-Command)

(Inherited from CommandInfo)
Verb

Gets the verb of the function
Version

Gets the source version (shown by default in Get-Command)

(Inherited from CommandInfo)
Visibility

Indicates if the command is to be allowed to be executed by a request external to the runspace.

(Inherited from CommandInfo)

Methods

ResolveParameter(String)

Resolves a full, shortened, or aliased parameter name to the actual cmdlet parameter name, using PowerShell's standard parameter resolution algorithm.

(Inherited from CommandInfo)
ToString()

for diagnostic purposes

(Inherited from CommandInfo)
Update(FunctionInfo, Boolean, ScopedItemOptions, String)

Applies to