ValidatePattern 属性声明

ValidatePattern 属性指定一个正则表达式模式,用于验证 cmdlet 参数的参数。 Windows PowerShell 函数也可以使用此属性。

在 cmdlet 中调用 ValidatePattern 时,Windows PowerShell 运行时会将 cmdlet 参数的参数转换为字符串,然后将该字符串与 ValidatePattern 属性提供的模式进行比较。 仅当参数转换后的字符串表示形式和提供的模式匹配时,才运行该 cmdlet。 如果不匹配,Windows PowerShell 运行时会引发错误。

语法

[ValidatePattern(string regexString)]
[ValidatePattern(string regexString, Named Parameters)]

参数

RegexStringSystem.String) 必需。 指定用于验证参数参数的正则表达式。

Options (System.Text.RegularExpressions.RegexOptions) 可选命名参数。 指定 System.Text.RegularExpressions.RegexOptions 指定正则表达式选项的标志的按位组合。

注解

  • 每个参数只能使用此属性一次。

  • 可以使用特性的 Option 参数进一步定义模式。 例如,可以将模式区分大小写。

  • 如果此属性应用于集合,则集合中的每个元素必须与模式匹配。

  • ValidatePattern 属性由 System.Management.Automation.ValidatePatternAttribute 类定义。

另请参阅

System.Management.Automation.ValidatePatternAttribute

编写 Windows PowerShell Cmdlet