en-US/ConvertFrom-PowerShellDataFile-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertFrom-PowerShellDataFile</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>PowerShellDataFile</command:noun> <maml:description> <maml:para>{{Converts the contents of a PowerShell Data File to a Hashtable Object accessible directly from the Command-Line.}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Converts the contents of a PowerShell Data File to an Object of the TypeName 'System.Collections.Hashtable', then stores the resulting Hashtable in a Variable which shares its name with the source files BaseName.}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertFrom-PowerShellDataFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Path"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to a PowerShell Data File.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Path"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to a PowerShell Data File.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ ConvertFrom-PowerShellDataFile -FilePath 'C:\test\MyModule\MyModule.psd1' }}</dev:code> <dev:remarks> <maml:para>{{ Converts the contents of the Module Manifest 'MyModule.psd1' to a Hashtable, which is then stored in the Variable: `$MyModule` }}</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> {{ cfpsd1 -Path 'C:\test\Data.psd1' }}</dev:code> <dev:remarks> <maml:para>{{ Converts the contents of the PowerShell Data File 'Data.psd1' to a Hashtable, which is then stored in the Variable `$Data` Uses Command AND Parameter Alias.}}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/SupernautFX/ConvertFrom-PowerShellDataFile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/SupernautFX/SFX.PoshUtilities.DataFileTools</maml:linkText> <maml:uri>https://github.com/SupernautFX/SFX.PoshUtilities.DataFileTools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |