en-US/pspestertesthelpers-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>Assert-PTHMandatoryParameter</command:name> <command:verb>Assert</command:verb> <command:noun>PTHMandatoryParameter</command:noun> <maml:description> <maml:para>Asserts that a function has only the mandatory parameters we pass.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Asserts that a function has only the mandatory parameters we pass. Returns true if it does and false otherwise.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Assert-PTHMandatoryParameter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FunctionName</maml:name> <maml:Description> <maml:para>{{Fill FunctionName Description}}</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ParameterName</maml:name> <maml:Description> <maml:para>{{Fill ParameterName Description}}</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FunctionName</maml:name> <maml:Description> <maml:para>{{Fill FunctionName Description}}</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ParameterName</maml:name> <maml:Description> <maml:para>{{Fill ParameterName Description}}</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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Paul Broadwith https://github.com/pauby History: 2019-01-09 - pauby - Initial release</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Assert-MandatoryParameter -FunctionName 'Get-MyFunction' -ParameterName 'Name'</dev:code> <dev:remarks> <maml:para>Asserts that the function 'Get-MyFunction' has only one mandatory parameter called 'Name'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/pauby/pspestertesthelpers/blob/master/docs/Get-PTHMandatoryParameter.md</maml:linkText> <maml:uri>https://github.com/pauby/pspestertesthelpers/blob/master/docs/Get-PTHMandatoryParameter.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Get-PTHFunctionParameter</command:name> <command:verb>Get</command:verb> <command:noun>PTHFunctionParameter</command:noun> <maml:description> <maml:para>Gets the parameters and their properties for a specified function.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the parameters and their properties for a specified function. The function must exist within the 'Function:' provider so will not work on cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PTHFunctionParameter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the function. The function must exist within the 'Function:' provider or an exception will be thrown.</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="2" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>Array of parameter names to exclude. By default the Advanced Functions common parameters are excluded. Pass an empty array to have all parameters returned.</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>@('Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable')</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>Name</maml:name> <maml:Description> <maml:para>Name of the function. The function must exist within the 'Function:' provider or an exception will be thrown.</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="2" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>Array of parameter names to exclude. By default the Advanced Functions common parameters are excluded. Pass an empty array to have all parameters returned.</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>@('Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable')</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Author : Paul Broadwith (https://github.com/pauby) History : 2018-03-17 - pauby - Initial release</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PTHFunctionParameter -Name 'Get-FunctionParameters'</dev:code> <dev:remarks> <maml:para>Returns the properties of each function parameter for the 'Import-Module' function excluding the common parameters for Advanced Functions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PTHFunctionParameter -Name 'Get-FunctionParameters' -Exclude ''</dev:code> <dev:remarks> <maml:para>Returns the properties of each function parameter for the 'Import-Module' function excluding no parameter names.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/pauby/pspestertesthelpers/blob/master/docs/Get-PTHFunctionParameter.md</maml:linkText> <maml:uri>https://github.com/pauby/pspestertesthelpers/blob/master/docs/Get-PTHFunctionParameter.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |