en-US/PSScriptModule/PSScriptModule-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems 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" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Get-PSScriptModuleInfo</command:name> <maml:description> <maml:para>Retrieves information from a PowerShell script module manifest file.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PSScriptModuleInfo</command:noun> </command:details> <maml:description> <maml:para>The Get-PSScriptModuleInfo function reads a PowerShell script module manifest file (.psd1) and extracts key information such as ModuleVersion, GUID, Author, Description, and CompanyName.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSScriptModuleInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ModulePath</maml:name> <maml:description> <maml:para>The file path to the PowerShell script module manifest (.psd1) from which to retrieve information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ModulePath</maml:name> <maml:description> <maml:para>The file path to the PowerShell script module manifest (.psd1) from which to retrieve information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>This function requires PowerShell 5.0 or later. Ensure the module manifest file exists and is accessible. Errors during import will be caught and reported. The function returns a custom object with module information.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>Get-PSScriptModuleInfo -ModulePath "C:\Modules\MyModule\MyModule.psd1" Retrieves module information from the specified module manifest file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri>https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/import-powershelldatafile</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText /> <command:uri>https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/import-powershelldatafile</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |