ConvertFrom-PowerShellDataFile

0.9.8

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>Generates a Hashtable from a specified PowerShell Data File.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Generates a Hashtable from the data stored within a specified valid PowerShell Data File ( .psd1 file), which is then stored within a Variable sharing its name with the source .psd1 file's BaseName. (Example: If the Filename is 'Data.psd1', then the Hashtable generated from its contents can be referenced using the Variable: '$Data', and individual Keys referenced via dot notation: '$Data.Key1.Key2' etc.)</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>ConvertFrom-PowerShellDataFile</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <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="none">

          <maml:name>RequireValidation</maml:name>

          <maml:Description>

            <maml:para>When specified, the target *.psd1 file MUST be a VALID Module Manifest. (Uses Test-ModuleManifest to Validate contents of the Manifest.) If 'Test-ModuleManifest' returns a value of $false (File failed to pass Validation) then any issues discovered are highlighted and displayed to the User.</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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <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="none">

        <maml:name>RequireValidation</maml:name>

        <maml:Description>

          <maml:para>When specified, the target *.psd1 file MUST be a VALID Module Manifest. (Uses Test-ModuleManifest to Validate contents of the Manifest.) If 'Test-ModuleManifest' returns a value of $false (File failed to pass Validation) then any issues discovered are highlighted and displayed to the User.</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="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="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>@param 'FilePath' - System.IO.Path</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>'$&lt;FileBaseName&gt;' - '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>Filename: 'ConvertFrom-PowerShellDataFile.psm1' Version: 0.9.5 Author: Nathaniel Wallis Praytor</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>ConvertFrom-PowerShellDataFile -FilePath 'C:\test\MyModule\PSScriptAnalyzerSettings.psd1'</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>

        <dev:code>ConvertFrom-PowerShellDataFile -FilePath 'C:\test\MyModule\MyModule.psd1' -RequireValidation</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <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>