This topic has not yet been rated - Rate this topic

ValidateRangeAttribute Class

Defines an attribute that uses minimum and maximum values to validate a cmdlet parameter argument. (This attribute can also be used by Windows PowerShell functions.) This class cannot be inherited.

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

Usage

'Usage
Dim instance As ValidateRangeAttribute

Syntax

C++

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field)] 
public sealed class ValidateRangeAttribute : ValidateEnumeratedArgumentsAttribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field) */ 
public final class ValidateRangeAttribute extends ValidateEnumeratedArgumentsAttribute

JScript

AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field) 
public final class ValidateRangeAttribute extends ValidateEnumeratedArgumentsAttribute

Example

This example specifies a range of 0 to 5 for the InputData parameter.

[ValidateRange(0, 5)]
[Parameter(Position = 0, Mandatory = true)]
public int InputData
{
  get { return inputData; }
  set { inputData = value; }
}

private int inputData;

Remarks

There are no established scenarios for explicitly creating a ValidateRangeAttribute object from within a cmdlet. The ValidateRangeAttribute object is created and used indirectly when the attribute is declared.

The cmdlet declares this attribute when implementing a cmdlet parameter. For more information about the syntax and parameters used to declare this attribute within a cmdlet, see ValidateRange Attribute Declaration.

Inheritance Hierarchy

System.Object
   System.Attribute
     System.Management.Automation.Internal.CmdletMetadataAttribute
       System.Management.Automation.ValidateArgumentsAttribute
         System.Management.Automation.ValidateEnumeratedArgumentsAttribute
           System.Management.Automation.ValidateRangeAttribute

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

ValidateRangeAttribute Members
System.Management.Automation Namespace

Other Resources

ValidateRange Attribute Declaration
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)