FineFormat

1.0.0

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 and filters the output.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Cmdlet formats and filters the output using various requirements.</maml:para>
      <maml:para>If used without parameters, it does not change accepted objects in any way.</maml:para>
      <maml:para>Can also be referred to 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="HaveValue, NotNullOrEmpty">
          <maml:name>HasValue</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:para>Aliases: HaveValue, NotNullOrEmpty</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>CompactNumbers</maml:name>
          <maml:description>
            <maml:para>Displays numbers as KB, MB, GB, TB, or PB depending on the magnitude of the number.</maml:para>
            <maml:para>If the number is smaller than 1KB, it is displayed without conversion.</maml:para>
            <maml:para>It differs from the -NumbersAs parameter in the way, that -NumbersAs parameter uses the specified units (KB, MB, etc.), and -CompactNumbers determines the proper unit based on the number's magnitude.</maml:para>
            <maml:para>This parameter has priority over the -NumbersAs parameter.</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>NumberGroupSeparator</maml:name>
          <maml:description>
            <maml:para>Displays numbers with group separators.</maml:para>
            <maml:para>Group separator symbol depends on regional settings.</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="NullOrEmpty">
          <maml:name>NoValue</maml:name>
          <maml:description>
            <maml:para>Specifies that only the properties that have $null or empty values should be displayed.</maml:para>
            <maml:para>Alias: NullOrEmpty</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>NumbersAs</maml:name>
          <maml:description>
            <maml:para>Displays numbers as KB, MB, GB, TB, or PB.</maml:para>
            <maml:para>If the number is smaller than the specified value, it is displayed without conversion.</maml:para>
            <maml:para>It differs from the -CompactNumbers parameter in the way, that -NumbersAs parameter uses the specified units (KB, MB, etc.), and -CompactNumbers determines the proper unit based on the number's magnitude.</maml:para>
            <maml:para>The -CompactNumbers parameter has priority over this parameter.</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>NumericTypes</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>SymbolicTypes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>ValueFilter</maml:name>
          <maml:description>
            <maml:para>Specifies scriptblock to be used for filtering by properties values.</maml:para>
            <maml:para>For example: -ValueFilter {$PSItem -like "somevalue"}</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
          <dev:type>
            <maml:name>ScriptBlock</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>TypeNameFilter</maml:name>
          <maml:description>
            <maml:para>Specifies scriptblock to be used for filtering by properties value type names.</maml:para>
            <maml:para>For example: -TypeNameFilter {$PSItem -like "datatype"}</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
          <dev:type>
            <maml:name>ScriptBlock</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="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="HaveValue, NotNullOrEmpty">
        <maml:name>HasValue</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:para>Aliases: HaveValue, NotNullOrEmpty</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>CompactNumbers</maml:name>
        <maml:description>
          <maml:para>Displays numbers as KB, MB, GB, TB, or PB depending on the magnitude of the number.</maml:para>
          <maml:para>If the number is smaller than 1KB, it is displayed without conversion.</maml:para>
          <maml:para>It differs from the -NumbersAs parameter in the way, that -NumbersAs parameter uses the specified units (KB, MB, etc.), and -CompactNumbers determines the proper unit based on the number's magnitude.</maml:para>
          <maml:para>This parameter has priority over the -NumbersAs parameter.</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>NumberGroupSeparator</maml:name>
        <maml:description>
          <maml:para>Displays numbers with group separators.</maml:para>
          <maml:para>Group separator symbol depends on regional settings.</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="NullOrEmpty">
        <maml:name>NoValue</maml:name>
        <maml:description>
          <maml:para>Specifies that only the properties that have $null or empty values should be displayed.</maml:para>
          <maml:para>Alias: NullOrEmpty</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>NumbersAs</maml:name>
        <maml:description>
          <maml:para>Displays numbers as KB, MB, GB, TB, or PB.</maml:para>
          <maml:para>If the number is smaller than the specified value, it is displayed without conversion.</maml:para>
          <maml:para>It differs from the -CompactNumbers parameter in the way, that -NumbersAs parameter uses the specified units (KB, MB, etc.), and -CompactNumbers determines the proper unit based on the number's magnitude.</maml:para>
          <maml:para>The -CompactNumbers parameter has priority over this parameter.</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>NumericTypes</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>SymbolicTypes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>ValueFilter</maml:name>
        <maml:description>
          <maml:para>Specifies scriptblock to be used for filtering by properties values.</maml:para>
          <maml:para>For example: -ValueFilter {$PSItem -like "somevalue"}</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
        <dev:type>
          <maml:name>ScriptBlock</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>TypeNameFilter</maml:name>
        <maml:description>
          <maml:para>Specifies scriptblock to be used for filtering by properties value type names.</maml:para>
          <maml:para>For example: -TypeNameFilter {$PSItem -like "datatype"}</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
        <dev:type>
          <maml:name>ScriptBlock</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</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 -HasValue
 
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 -NoValue
 
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 values of numeric types ---</maml:title>
        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -NumericTypes
 
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 values of numeric types (Int, Double, etc.).</maml:para>
          <maml:para/>
          <maml:para/>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>--- Example 4: Properties that have values of symbolic types ---</maml:title>
        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -SymbolicTypes
 
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 values of symbolic types (String, Char).</maml:para>
          <maml:para/>
          <maml:para/>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>------- Example 5: Display numbers with group separator -------</maml:title>
        <dev:code>Get-CimInstance -ClassName Win32_LogicalDisk -Filter "DeviceID='C:'" | ff -HasValue -NumericTypes -NumberGroupSeparator
 
Access : 0
FreeSpace : 57,692,909,568
Size : 214,223,253,504
DriveType : 3
MaximumComponentLength : 255
MediaType : 12</dev:code>
        <dev:remarks>
          <maml:para>Use the -NumberGroupSeparator parameter to display numbers with group separators.</maml:para>
          <maml:para/>
          <maml:para/>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>--------------- Example 6: Display numbers as MB ---------------</maml:title>
        <dev:code>Get-CimInstance -ClassName Win32_LogicalDisk -Filter "DeviceID='C:'" | ff -HasValue -NumericTypes -NumberGroupSeparator -NumbersAs MB
 
Access : 0
FreeSpace : 55,018.6 MB
Size : 204,299.21 MB
DriveType : 3
MaximumComponentLength : 255
MediaType : 12</dev:code>
        <dev:remarks>
          <maml:para>Use the -NumbersAs parameter with the value of MB to display numbers as MB.</maml:para>
          <maml:para/>
          <maml:para/>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>------------------ Example 7: Compact numbers ------------------</maml:title>
        <dev:code>Get-CimInstance -ClassName Win32_LogicalDisk -Filter "DeviceID='C:'" | ff -HasValue -NumericTypes -CompactNumbers
 
Access : 0
FreeSpace : 53.73 GB
Size : 199.51 GB
DriveType : 3
MaximumComponentLength : 255
MediaType : 12</dev:code>
        <dev:remarks>
          <maml:para>Display numbers in their most compact form using KB, MB, GB, TB, and PB units.</maml:para>
          <maml:para/>
          <maml:para/>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>------- Example 8: Properties that have specific values -------</maml:title>
        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -ValueFilter {$PSItem -like "*adapter"}
 
Caption Description
------- -----------
[00000010] Hyper-V Virtual Switch Extension Adapter Hyper-V Virtual Switch Extension Adapter</dev:code>
        <dev:remarks>
          <maml:para>Get only the properties that have specific values.</maml:para>
          <maml:para/>
          <maml:para/>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>--------- Example 9: Properties of specified data type ---------</maml:title>
        <dev:code>Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index=10" | ff -HasValue -TypeNameFilter {$PSItem -like "*int"}
 
Index InterfaceIndex
----- --------------
   10 9</dev:code>
        <dev:remarks>
          <maml:para>Get only the properties of specific data type.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>