Share via

FunctionDefinitionAst.GetHelpContent Method

  • Reference

Definition

Namespace:
System.Management.Automation.Language
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Overloads

GetHelpContent()

Return the help content, if any, for the function.
GetHelpContent(Dictionary<Ast,Token[]>)

Return the help content, if any, for the function. Use this overload when parsing multiple functions within a single scope.

GetHelpContent()

Return the help content, if any, for the function.

public:
 System::Management::Automation::Language::CommentHelpInfo ^ GetHelpContent();
public System.Management.Automation.Language.CommentHelpInfo GetHelpContent ();
member this.GetHelpContent : unit -> System.Management.Automation.Language.CommentHelpInfo
Public Function GetHelpContent () As CommentHelpInfo

Returns

CommentHelpInfo

Applies to

GetHelpContent(Dictionary<Ast,Token[]>)

Return the help content, if any, for the function. Use this overload when parsing multiple functions within a single scope.

public:
 System::Management::Automation::Language::CommentHelpInfo ^ GetHelpContent(System::Collections::Generic::Dictionary<System::Management::Automation::Language::Ast ^, cli::array <System::Management::Automation::Language::Token ^> ^> ^ scriptBlockTokenCache);
public System.Management.Automation.Language.CommentHelpInfo GetHelpContent (System.Collections.Generic.Dictionary<System.Management.Automation.Language.Ast,System.Management.Automation.Language.Token[]> scriptBlockTokenCache);
member this.GetHelpContent : System.Collections.Generic.Dictionary<System.Management.Automation.Language.Ast, System.Management.Automation.Language.Token[]> -> System.Management.Automation.Language.CommentHelpInfo
Public Function GetHelpContent (scriptBlockTokenCache As Dictionary(Of Ast, Token())) As CommentHelpInfo

Parameters

scriptBlockTokenCache
Dictionary<Ast,Token[]>

A dictionary that the parser will use to map AST nodes to their respective tokens. The parser uses this to improve performance while repeatedly parsing the parent script blocks of a function (since the parent script blocks may contain help comments related to this function. To conserve memory, clear / null-out this cache when done with repeated parsing.

Returns

CommentHelpInfo

Applies to