Command

Get-BenchmarkInput

Module: PSPublishModule
Inputs: None
Outputs: System.String System.Int32 System.Boolean

Gets a caller-supplied benchmark input variable.

Syntax

Get-BenchmarkInput
[[-Default] <Object>]
[-Name] <String>
[-Required]
[<CommonParameters>]

Parameter set: Text

Get-BenchmarkInput
[[-Default] <Object>]
-Int
[-Name] <String>
[-Required]
[<CommonParameters>]

Parameter set: Int

Get-BenchmarkInput
-Bool
[[-Default] <Object>]
[-Name] <String>
[-Required]
[<CommonParameters>]

Parameter set: Bool

Examples

Example 1

Get-BenchmarkInput -Name 'Name'

Example 2

Get-BenchmarkInput -Bool

Example 3

Get-BenchmarkInput -Int

Parameters

-Default Object optionalposition: 1: Default value used when the variable was not supplied.
-Name String requiredposition: 0: Benchmark variable name.
-Required SwitchParameter optional: Fail when the variable was not supplied or is empty.
-Int SwitchParameter requiredsets: Int: Return the benchmark variable as one or more integers.
-Bool SwitchParameter requiredsets: Bool: Return the benchmark variable as a boolean.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.