0 out of 1 rated this helpful - Rate this topic

ParameterAttribute.ValueFromPipelineByPropertyName Property

Gets and sets a Boolean value that indicates that the parameter can take values from a property of the incoming pipeline object that has the same name as this parameter. For example, if the name of the cmdlet or function parameter is userName, the parameter can take values from the userName property of incoming objects.

Namespace: System.Management.Automation
Assembly: System.Management.Automation (in System.Management.Automation.dll)

Usage

'Usage
Dim instance As ParameterAttribute
Dim value As Boolean

value = instance.ValueFromPipelineByPropertyName

instance.ValueFromPipelineByPropertyName = value

Syntax

C++

public bool ValueFromPipelineByPropertyName { get; set; }

/** @property */
public boolean get_ValueFromPipelineByPropertyName ()

/** @property */
public void set_ValueFromPipelineByPropertyName (boolean value)

JScript

public function get ValueFromPipelineByPropertyName () : boolean

public function set ValueFromPipelineByPropertyName (value : boolean)

Property Value

A Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name. The default is false .

Example

This example shows how the Parameter attribute is used to declare a parameter that accepts input from a property of the incoming pipeline object that has the same name as this parameter.

[Parameter(ValueFromPipelineByPropertyName = true)]
public string ComputerName
{
    get { return computerName; }
    set { computerName = value; }
}
private string computerName;

Remarks

This property is an optional Named parameter of the Parameter attribute. For more information about the declaration syntax that is used to specify the Parameter attribute for cmdlets, see ParameterAttribute Declaration.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows Developer Preview, Windows Server Developer Preview

Change History

Reference

ParameterAttribute Class
ParameterAttribute Members
System.Management.Automation Namespace

Other Resources

ParameterAttribute Declaration
Cmdlet Parameters
Windows PowerShell SDK

Send comments about this topic to Microsoft.

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)