en-US/PS.Tools.Utility-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>Out-Animate</command:name> <command:verb>Out</command:verb> <command:noun>Animate</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Visually output a string to the console. The text is progressivly written to the console.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-Animate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{ Fill InputObject 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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ForegroundColor</maml:name> <maml:Description> <maml:para>Defines the color of the text to be written.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">White</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ConsoleColor</command:parameterValue> <dev:type> <maml:name>ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>White</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AnimationSpeed</maml:name> <maml:Description> <maml:para>Defines the speed at which the text is written to the console.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{ Fill InputObject 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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ForegroundColor</maml:name> <maml:Description> <maml:para>Defines the color of the text to be written.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ConsoleColor</command:parameterValue> <dev:type> <maml:name>ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>White</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AnimationSpeed</maml:name> <maml:Description> <maml:para>Defines the speed at which the text is written to the console.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Description of example 'Hello World!' | Out-Animate -AnimationSpeed 50 -ForegroundColor 'Cyan'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |