FunctionDefinitionAst.GetHelpContent Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.CommentHelpInfoPublic Function GetHelpContent () As CommentHelpInfoReturns
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.CommentHelpInfoPublic Function GetHelpContent (scriptBlockTokenCache As Dictionary(Of Ast, Token())) As CommentHelpInfoParameters
- 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.