bin/DSCParser.CSharp.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>DSCParser.CSharp</name> </assembly> <members> <member name="T:DSCParser.CSharp.DscParser"> <summary> Main DSC Parser class that converts DSC configurations to/from objects </summary> </member> <member name="P:DSCParser.CSharp.DscParser.WarningSink"> <summary> Receives non-fatal diagnostics such as unresolvable modules. When unset, they are dropped rather than written to the console, which would corrupt a PowerShell host's output stream. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.ClearCaches"> <summary> Clears the process-wide resource, property and module caches. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.ConvertToDscObject(System.String,System.String,DSCParser.CSharp.DscParseOptions,System.Collections.Generic.List{System.Object})"> <summary> Converts a DSC configuration file or content to DSC objects </summary> </member> <member name="M:DSCParser.CSharp.DscParser.ConvertFromDscObject(System.Collections.Generic.IEnumerable{System.Collections.Hashtable},System.Int32)"> <summary> Converts DSC objects back to DSC configuration text </summary> </member> <member name="M:DSCParser.CSharp.DscParser.AppendDscObjects(System.Text.StringBuilder,System.Collections.Generic.IEnumerable{System.Collections.Hashtable},System.Int32)"> <summary> Renders resources into <paramref name="result"/>. Nested hashtables and arrays recurse into the same builder, so no intermediate strings are produced per nesting level. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.GetSingleVersionModules(System.Collections.Generic.HashSet{System.String})"> <summary> Returns the subset of <paramref name="moduleNames"/> that has exactly one version installed. Only those may have their -ModuleVersion stripped from the configuration; for modules with several versions installed the version is what selects the right one. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.GetModulesToLoad(System.String)"> <summary> Reads the Import-DSCResource statements straight from the configuration text, so the keywords can be registered before the configuration is parsed and the statements removed from that parse. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.ReportParseErrors(System.Management.Automation.Language.ParseError[],System.Management.Automation.Language.ConfigurationDefinitionAst,System.String)"> <summary> Errors outside the configuration block never affected the conversion, and registering the keywords up front makes PowerShell report some constructs that follow the block, such as the trailing invocation an export appends, as errors. Only errors inside the block are fatal. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.ConvertUsingRegisteredKeywords(System.String,System.String,DSCParser.CSharp.DscParseOptions)"> <summary> Converts a configuration against the keywords the caller registered from a schema cache. </summary> <remarks> The Node body is reparsed on its own because the engine empties the DynamicKeyword table when it enters a Configuration block, which would drop the registered keywords before any resource inside is reached. </remarks> </member> <member name="M:DSCParser.CSharp.DscParser.FindNodeBody(System.Management.Automation.Language.Ast)"> <summary> Returns the statements of the configuration's Node block as parsable text, or null when there is no Node statement. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.Unbrace(System.Management.Automation.Language.ScriptBlockExpressionAst)"> <summary> The contents of a scriptblock, which parse as a script where the braced form would parse as one expression. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.SkipUnresolvedResource(System.Collections.ObjectModel.ReadOnlyCollection{System.Management.Automation.Language.StatementAst},System.Int32)"> <summary> Reports a resource the installed modules no longer define and returns how many additional statements it spans. Such a resource is not a DSC keyword, so PowerShell parses it as a plain command: "Name Instance" followed by a detached body, or "Name Instance { ... }" on one line. </summary> </member> <member name="M:DSCParser.CSharp.DscParser.StripIndentOfOpeningLine(System.Text.StringBuilder,System.Int32)"> <summary> Removes the leading indentation of the first rendered line when that line opens a block, so the nested object starts directly after the "= " of its property assignment. </summary> </member> <member name="T:DSCParser.CSharp.DscResourceInstance"> <summary> Represents a parsed DSC resource instance </summary> </member> <member name="P:DSCParser.CSharp.DscResourceInstance.ResourceName"> <summary> Gets or sets the DSC resource type name </summary> </member> <member name="P:DSCParser.CSharp.DscResourceInstance.ResourceInstanceName"> <summary> Gets or sets the name given to this instance in the configuration </summary> </member> <member name="P:DSCParser.CSharp.DscResourceInstance.Properties"> <summary> Gets or sets the parsed properties of this instance </summary> </member> <member name="M:DSCParser.CSharp.DscResourceInstance.AddProperty(System.String,System.Object)"> <summary> Adds or updates a property value </summary> </member> <member name="M:DSCParser.CSharp.DscResourceInstance.GetProperty(System.String)"> <summary> Gets a property value </summary> </member> <member name="M:DSCParser.CSharp.DscResourceInstance.ToHashtable"> <summary> Converts to Hashtable for PowerShell compatibility </summary> </member> <member name="T:DSCParser.CSharp.DscParseOptions"> <summary> Options for DSC parsing </summary> </member> <member name="P:DSCParser.CSharp.DscParseOptions.IncludeComments"> <summary> Gets or sets whether comments are captured as _metadata_ properties </summary> </member> <member name="P:DSCParser.CSharp.DscParseOptions.IncludeCIMInstanceInfo"> <summary> Gets or sets whether CIM instance type names are emitted as CIMInstance keys </summary> </member> <member name="P:DSCParser.CSharp.DscParseOptions.Schema"> <summary> Gets or sets an optional schema definition </summary> </member> <member name="P:DSCParser.CSharp.DscParseOptions.UseRegisteredKeywords"> <summary> Gets or sets whether to parse against keywords already registered with DscKeywordRegistry.RegisterFromSchemaCache instead of resolving the configuration's modules. </summary> <remarks> Set this in a host that has no PowerShell modules on disk and no usable runspace. The configuration's Import-DscResource statements are then ignored rather than honoured, so what the caller registered is the complete set of resources the parse can resolve. </remarks> </member> </members> </doc> |