powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-Member



NAME
Get-Member

SYNOPSIS
Gets the properties and methods of objects.

SYNTAX
Get-Member [[-Name] ] [-Force] [-InputObject ] [-MemberType {AliasProperty | CodeProperty | Pro
perty | NoteProperty | ScriptProperty | Properties | PropertySet | Method | CodeMethod | ScriptMethod | Methods | P
arameterizedProperty | MemberSet | Event | All}] [-Static] [-View {Extended | Adapted | Base | All}] [ ters>]


DESCRIPTION
The Get-Member cmdlet gets the "members" (properties and methods) of objects.

To specify the object, use the InputObject parameter or pipe an object to Get-Member. To retrieve information about
static members (members of the class, not of the instance), use the Static parameter. To get only certain types of
members, such as NoteProperties, use the MemberType parameter.


PARAMETERS
-Force []
Adds the intrinsic members (PSBase, PSAdapted, PSObject, PSTypeNames) and the compiler-generated get_ and set_
methods to the display. By default, Get-Member gets these properties in all views other than "Base" and "Adapte
d," but it does not display them.

The following list describes the properties that are added when you use the Force parameter:

-- PSBase: The original properties of the .NET Framework object without extension or adaptation. These are the
properties defined for the object class and listed in MSDN.
-- PSAdapted: The properties and methods defined in the Windows PowerShell extended type system.
-- PSExtended: The properties and methods that were added in the Types.ps1xml files or by using the Add-Member
cmdlet.
-- PSObject: The adapter that converts the base object to a Windows PowerShell PSObject object.
-- PSTypeNames: A list of object types that describe the object, in order of specificity. When formatting the o
bject, Windows PowerShell searches for the types in the Format.ps1xml files in the Windows PowerShell installat
ion directory ($pshome). It uses the formatting definition for the first type that it finds.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-InputObject
Specifies the object whose members are retrieved.

Using the InputObject parameter is not the same as piping an object to Get-Member. The differences are as follo
ws:

-- When you pipe a collection of objects to Get-Member, Get-Member gets the members of the individual objects i
n the collection, such as the properties of the integers in an array of integers.

-- When you use InputObject to submit a collection of objects, Get-Member gets the members of the collection, s
uch as the properties of the array in an array of integers.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-MemberType
Gets only members with the specified member type. The default is All.

The valid values for this parameter are:

-- AliasProperty: A property that defines a new name for an existing property.
-- CodeMethod: A method that references a static method of a .NET Framework class.
-- CodeProperty: A property that references a static property of a .NET Framework class.
-- Event: Indicates that the object sends a message to indicate an action or a change in state.
-- MemberSet: A predefined collection of properties and methods, such as PSBase, PSObject, and PSTypeNames.
-- Method: A method of the underlying .NET Framework object.
-- NoteProperty: A property with a static value.
-- ParameterizedProperty: A property that takes parameters and parameter values.
-- Property: A property of the underlying .NET Framework object.
-- PropertySet: A predefined collection of object properties.
-- ScriptMethod: A method whose value is the output of a script.
-- ScriptProperty: A property whose value is the output of a script.

-- All: Gets all member types.
-- Methods: Gets all types of methods of the object (for example, Method, CodeMethod, ScriptMethod).
-- Properties: Gets all types of properties of the object (for example, Property, CodeProperty, AliasProperty,
ScriptProperty).

Not all objects have every type of member. If you specify a member type that the object does not have, Windows
PowerShell returns a null value.

To get related types of members, such as all extended members, use the View parameter. If you use the MemberTyp
e parameter with the Static or View parameters, Get-Member gets the members that belong to both sets.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Name
Specifies the names of one or more properties or methods of the object. Get-Member gets only the specified prop
erties and methods.

If you use the Name parameter with the MemberType, View, or Static parameters, Get-Member gets only the members
that satisfy the criteria of all parameters.

To get a static member by name, use the Static parameter with the Name parameter.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Static []
Gets only the static properties and methods of the object.

Static properties and methods are defined on the class of objects, not on any particular instance of the class.

If you use the Static parameter with the View parameter, the View parameter is ignored. If you use the Static p
arameter with the MemberType parameter, Get-Member gets only the members that belong to both sets.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-View
Gets only particular types of members (properties and methods). Specify one or more of the values. The default
is "Adapted, Extended".

Valid values are:
-- Base: Gets only the original properties and methods of the .NET Framework object (without extension or adap
tation).
-- Adapted: Gets only the properties and methods defined in the Windows PowerShell extended type system.
-- Extended: Gets only the properties and methods that were added in the Types.ps1xml files or by using the Add
-Member cmdlet.
-- All: Gets the members in the Base, Adapted, and Extended views.

The View parameter determines the members retrieved, not just the display of those members.

To get particular member types, such as script properties, use the MemberType parameter. If you use the MemberT
ype and View parameters in the same command, Get-Member gets the members that belong to both sets. If you use t
he Static and View parameters in the same command, the View parameter is ignored.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Management.Automation.PSObject
You can pipe any object to Get-Member


OUTPUTS
Microsoft.PowerShell.Commands.MemberDefinition
Get-Member returns an object for each property or method that its gets.


NOTES


You can retrieve information about a collection object either by using the InputObject parameter or by piping t
he object, preceded by a comma, to Get-Member.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>get-service | get-member


TypeName: System.ServiceProcess.ServiceController

Name MemberType Definition
---- ---------- ----------
Name AliasProperty Name = ServiceName
Close Method System.Void Close()
Continue Method System.Void Continue()
CreateObjRef Method System.Runtime.Remoting.ObjRef CreateObjRef(Type requestedType)
Dispose Method System.Void Dispose()
Equals Method System.Boolean Equals(Object obj)
ExecuteCommand Method System.Void ExecuteCommand(Int32 command)
GetHashCode Method System.Int32 GetHashCode()
GetLifetimeService Method System.Object GetLifetimeService()
GetType Method System.Type GetType()
InitializeLifetimeService Method System.Object InitializeLifetimeService()
Pause Method System.Void Pause()
Refresh Method System.Void Refresh()
Start Method System.Void Start(), System.Void Start(String[] args)
Stop Method System.Void Stop()
ToString Method System.String ToString()
WaitForStatus Method System.Void WaitForStatus(ServiceControllerStatus desiredStatus), System.Vo
i...
CanPauseAndContinue Property System.Boolean CanPauseAndContinue {get;}
CanShutdown Property System.Boolean CanShutdown {get;}
CanStop Property System.Boolean CanStop {get;}
Container Property System.ComponentModel.IContainer Container {get;}
DependentServices Property System.ServiceProcess.ServiceController[] DependentServices {get;}
DisplayName Property System.String DisplayName {get;set;}
MachineName Property System.String MachineName {get;set;}
ServiceHandle Property System.Runtime.InteropServices.SafeHandle ServiceHandle {get;}
ServiceName Property System.String ServiceName {get;set;}
ServicesDependedOn Property System.ServiceProcess.ServiceController[] ServicesDependedOn {get;}
ServiceType Property System.ServiceProcess.ServiceType ServiceType {get;}
Site Property System.ComponentModel.ISite Site {get;set;}
Status Property System.ServiceProcess.ServiceControllerStatus Status {get;}


Description
-----------
This command displays the properties and methods of the process objects (System.ServiceProcess.ServiceController) t
hat are generated by the Get-Service cmdlet.

The command uses the pipeline operator (|) to send the output of a Get-Service command to Get-Member.

Because the Get-Member part of the command does not have any parameters, it uses all of the default values. As such
, it gets all member types, but it does not get static members and does not display intrinsic members.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>get-service | get-member -force

C:\PS> (get-service -schedule).psbase


Description
-----------
This example gets all of the members (properties and methods) of the service objects (System.ServiceProcess.Service
Controller) retrieved by the Get-Service cmdlet, including the intrinsic members, such as PSBase and PSObject, and
the get_ and set_ methods.

The first command uses the Get-Service cmdlet to get objects that represent the services on the system. It uses a p
ipeline operator (|) to pass the service objects to the Get-Member cmdlet.

The Get-Member command uses the Force parameter to add the intrinsic members and compiler-generated members of the
objects to the display. Get-Member gets these members, but it hides them by default.

You can use these properties and methods in the same way that you would use an adapted method of the object. The se
cond command shows how to display the value of the PSBase property of the Schedule service.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>get-service | get-member -view extended

TypeName: System.ServiceProcess.ServiceController

Name MemberType Definition
---- ---------- ----------
Name AliasProperty Name = ServiceName


Description
-----------
This command gets the methods and properties of service objects that were extended by using the Types.ps1xml file o
r the Add-Member cmdlet.


The Get-Member command uses the View parameter to get only the extended members of the service objects. In this cas
e, the extended member is the Name property, which is an alias property of the ServiceName property.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>get-eventlog -log system | gm -membertype scriptproperty

TypeName: System.Diagnostics.EventLogEntry

Name MemberType Definition
---- ---------- ----------
EventID ScriptProperty System.Object EventID {get=$this.get_EventID() -band 0xFFFF;}


Description
-----------
This command gets the script properties of event log objects in the System log in Event Viewer. In this case, the o
nly script property is the EventID.





-------------------------- EXAMPLE 5 --------------------------

C:\PS>get-eventlog -log system | get-member -membertype scriptproperty


TypeName: System.Diagnostics.EventLogEntry

Name MemberType Definition
---- ---------- ----------
EventID ScriptProperty System.Object EventID {get=$this.get_EventID() -band 0xFFFF;}


Description
-----------
This command gets the script properties of event log objects in the System log in Event Viewer.

The command uses the MemberType parameter to get only objects with a value of AliasProperty for their MemberType pr
operty.

The command returns the EventID property of the EventLog object.





-------------------------- EXAMPLE 6 --------------------------

C:\PS>$a = "get-process", "get-service", "get-culture", "get-psdrive", "get-executionpolicy"

C:\PS> foreach ($cmdlet in $a) {invoke-expression $cmdlet | get-member -name machinename}

TypeName: System.Diagnostics.Process

Name MemberType Definition
---- ---------- ----------
MachineName Property System.String MachineName {get;}


TypeName: System.ServiceProcess.ServiceController

Name MemberType Definition
---- ---------- ----------
MachineName Property System.String MachineName {get;set;}


Description
-----------
This command gets objects that have a MachineName property from a list of cmdlets.

The first command stores the names of several cmdlets in the $a variable.

The second command uses a ForEach statement to invoke each command, send the results to Get-Member, and limit the r
esults from Get-Member to members that have the name "MachineName."

The results show that only process objects (System.Diagnostics.Process) and service objects (System.ServiceProcess.
ServiceController) have a MachineName property.





-------------------------- EXAMPLE 7 --------------------------

C:\PS>$a = get-member -inputobject @(1)

C:\PS>$a.count

1

C:\PS> $a = get-member -inputobject 1,2,3

TypeName: System.Object[]
Name MemberType Definition
---- ---------- ----------
Count AliasProperty Count = Length
Address Method System.Object& Address(Int32 )
Clone Method System.Object Clone()
...

C:\PS>$a.count
1


Description
-----------
This example demonstrates how to find the properties and methods of an array of objects when you have only one obje
ct of the given type.

Because the goal of the command is to find the properties of an array, the first command uses the InputObject param
eter. It uses the "at" symbol (@) to indicate an array. In this case, the array contains only one object, the integ
er 1.

The third command uses the Get-Member cmdlet to get the properties and methods of an array of integers, and the com
mand saves them in the $a variable.

The fourth command uses the Count property of the array to find the number of objects in the $a variable.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113322
Add-Member
Get-Help
Get-Command
Get-PSDrive