FineFormat

0.2

en-us/FineFormat-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>Format-Fine</command:name>

      <command:verb>Format</command:verb>

      <command:noun>Fine</command:noun>

      <maml:description>

        <maml:para>Formats commands output</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Cmdlet formats commands output using various requirements.</maml:para>

      <maml:para>If used without any parameters, it does not change accepted objects in any way.</maml:para>

      <maml:para>Can also be referred by its alias: ff.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Format-Fine</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:description>

            <maml:para>Specifies the input object.</maml:para>

            <maml:para>This parameter supports accepting values from the pipeline.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</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>NotNullOrEmpty</maml:name>

          <maml:description>

            <maml:para>Specifies that only the properties that have values other than $null or empty should be displayed.</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="none">

          <maml:name>NullOrEmpty</maml:name>

          <maml:description>

            <maml:para>Specifies that only the properties that have $null or empty values should be displayed.</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="none">

          <maml:name>Numeric</maml:name>

          <maml:description>

            <maml:para>Specifies that only the properties that have numeric values (Int, Double, etc.) should be displayed.</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="none">

          <maml:name>Textual</maml:name>

          <maml:description>

            <maml:para>Specifies that only the properties that have textual values (String, Char) should be displayed.</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="True (ByValue)" position="0" aliases="none">

        <maml:name>InputObject</maml:name>

        <maml:description>

          <maml:para>Specifies the input object.</maml:para>

          <maml:para>This parameter supports accepting values from the pipeline.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</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>NotNullOrEmpty</maml:name>

        <maml:description>

          <maml:para>Specifies that only the properties that have values other than $null or empty should be displayed.</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="none">

        <maml:name>NullOrEmpty</maml:name>

        <maml:description>

          <maml:para>Specifies that only the properties that have $null or empty values should be displayed.</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="none">

        <maml:name>Numeric</maml:name>

        <maml:description>

          <maml:para>Specifies that only the properties that have numeric values (Int, Double, etc.) should be displayed.</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="none">

        <maml:name>Textual</maml:name>

        <maml:description>

          <maml:para>Specifies that only the properties that have textual values (String, Char) should be displayed.</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.Object</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.Object</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: Properties that have values other than $null or empty</maml:title>

        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -NotNullOrEmpty

Caption               : [00000010] Hyper-V Virtual Switch Extension Adapter

Description           : Hyper-V Virtual Switch Extension Adapter

SettingID             : {946D7DBF-BE1D-4236-80AC-45892A467346}

DHCPEnabled           : False

Index                 : 10

InterfaceIndex        : 9

IPEnabled             : False

ServiceName           : VMSMP

CimClass              : root/cimv2:Win32_NetworkAdapterConfiguration

CimInstanceProperties : {Caption, Description, SettingID, ArpAlwaysSourceRoute…}

CimSystemProperties   : Microsoft.Management.Infrastructure.CimSystemProperties</dev:code>

        <dev:remarks>

          <maml:para>Get only the properties that have values other than $null or empty.</maml:para>

          <maml:para/>

          <maml:para/>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>---- Example 2: Properties that have $null or empty values ----</maml:title>

        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -NullOrEmpty

ArpAlwaysSourceRoute         :

ArpUseEtherSNAP              :

DatabasePath                 :

DeadGWDetectEnabled          :

DefaultIPGateway             :

DefaultTOS                   :

DefaultTTL                   :

DHCPLeaseExpires             :

DHCPLeaseObtained            :

DHCPServer                   :

DNSDomain                    :

DNSDomainSuffixSearchOrder   :

...</dev:code>

        <dev:remarks>

          <maml:para>Get only the properties that have $null or empty values.</maml:para>

          <maml:para/>

          <maml:para/>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------- Example 3: Properties that have numeric values --------</maml:title>

        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -Numeric

ForwardBufferMemory          :

Index                        : 10

InterfaceIndex               : 9

IPConnectionMetric           :

IPXMediaType                 :

KeepAliveInterval            :

KeepAliveTime                :

MTU                          :

NumForwardPackets            :

TcpipNetbiosOptions          :

TcpMaxConnectRetransmissions :

TcpMaxDataRetransmissions    :

TcpNumConnections            :

TcpWindowSize                :</dev:code>

        <dev:remarks>

          <maml:para>Get only the properties that have numeric values.</maml:para>

          <maml:para/>

          <maml:para/>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------- Example 4: Properties that have textual values --------</maml:title>

        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -Textual

Caption             : [00000010] Hyper-V Virtual Switch Extension Adapter

Description         : Hyper-V Virtual Switch Extension Adapter

SettingID           : {946D7DBF-BE1D-4236-80AC-45892A467346}

DatabasePath        :

DHCPServer          :

DNSDomain           :

DNSHostName         :

IPXAddress          :

IPXVirtualNetNumber :

MACAddress          :

ServiceName         : VMSMP

WINSHostLookupFile  :

WINSPrimaryServer   :

WINSScopeID         :

WINSSecondaryServer :

PSComputerName      :</dev:code>

        <dev:remarks>

          <maml:para>Get only the properties that have textual values.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>