Share via


Measure-Object

Applies To: Windows PowerShell 2.0

Calculates the numeric properties of objects, and the characters, words, and lines in string objects, such as files of text.

Syntax

Measure-Object [-Average] [-Maximum] [-Minimum] [-Sum] [[-Property] <string[]>] [-InputObject <psobject>] [<CommonParameters>]

Measure-Object [-Character] [-IgnoreWhiteSpace] [-Line] [-Word] [[-Property] <string[]>] [-InputObject <psobject>] [<CommonParameters>]

Description

The Measure-Object cmdlet calculates the property values of certain types of object. Measure-Object performs three types of measurements, depending on the parameters in the command.

The Measure-Object cmdlet performs calculations on the property values of objects. It can count objects and calculate the minimum, maximum, sum, and average of the numeric values. For text objects, it can count and calculate the number of lines, words, and characters.

Parameters

-Average

Displays the average value of the specified properties.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Character

Counts the number of characters in the input object.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IgnoreWhiteSpace

Ignores white space in word counts and character counts. By default, white space is not ignored.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject <psobject>

Specifies the objects to be measured. Enter a variable that contains the objects, or type a command or expression that gets the objects.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Line

Counts the number of lines in the input object.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Maximum

Displays the maximum value of the specified properties.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Minimum

Displays the minimum value of the specified properties.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Property <string[]>

Specifies one or more numeric properties to measure. The default is the Count (Length) property of the object.

Required?

false

Position?

1

Default Value

Count

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Sum

Displays the sum of the values of the specified properties.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Word

Counts the number of words in the input object.

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.

Inputs and Outputs

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.

Inputs

System.Management.Automation.PSObject

You can pipe objects to Measure-Object.

Outputs

GenericMeasureInfo or TextMeasureInfoObject

Example 1

C:\PS>get-childitem | measure-object

Description

-----------

This command counts the files and folders in the current directory.

Example 2

C:\PS>get-childitem | measure-object -property length -minimum -maximum -average

Description

-----------

This command displays the minimum, maximum, and sum of the sizes of all files in the current directory, and the average size of a file in the directory.

Example 3

C:\PS>get-content C:\test.txt | measure-object -character -line -word

Description

-----------

This command displays the number of characters, words, and lines in the Text.txt file.

Example 4

C:\PS>get-process | measure-object -property workingset -minimum -maximum -average

Description

-----------

This command displays the minimum, maximum, and average sizes of the working sets of the processes on the computer.

Example 5

C:\PS>import-csv d:\test\serviceyrs.csv | measure-object -property years -minimum -maximum -average

Description

-----------

This command calculates the average years of service of the employees of a company.

The ServiceYrs.csv file is a CSV file that contains the employee number and years of service of each employee. The first row in the table is a header row of "EmpNo, Years".

When you use Import-Csv to import the file, the result is a PSCustomObject with note properties of EmpNo and Years. You can use Measure-Object to calculate the values of these properties, just like any other property of an object.

Example 6

C:\PS>get-childitem | measure-object -property psiscontainer -max -sum -min -average

Count    : 126
Average  : 0.0634920634920635
Sum      : 8
Maximum  : 1
Minimum  : 0
Property : PSIsContainer

Description

-----------

This example demonstrates the Measure-Object can measure Boolean values. In this case, it uses the PSIsContainer Boolean property to measure the incidence of folders (versus files) in the current directory.

See Also

Concepts

Compare-Object
ForEach-Object
Group-Object
New-Object
Select-Object
Sort-Object
Tee-Object
Where-Object