|
1 | 1 | VFP
|
2 | 2 | ---
|
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
3 | 7 | ### Synopsis
|
4 | 8 | ValueFromPipline Shorthand
|
5 | 9 |
|
| 10 | + |
| 11 | + |
6 | 12 | ---
|
| 13 | + |
| 14 | + |
7 | 15 | ### Description
|
8 | 16 |
|
9 | 17 | This is syntax shorthand to create [Parameter] attributes that take ValueFromPipeline.
|
10 | 18 |
|
| 19 | + |
| 20 | + |
11 | 21 | ---
|
| 22 | + |
| 23 | + |
12 | 24 | ### Parameters
|
13 | 25 | #### **ParameterSet**
|
14 | 26 |
|
15 | 27 | The parameter set name.
|
16 | 28 |
|
17 | 29 |
|
18 | 30 |
|
19 |
| -> **Type**: ```[String]``` |
20 | 31 |
|
21 |
| -> **Required**: false |
22 | 32 |
|
23 |
| -> **Position**: 1 |
24 | 33 |
|
25 |
| -> **PipelineInput**:false |
| 34 | +|Type |Required|Position|PipelineInput|Aliases | |
| 35 | +|----------|--------|--------|-------------|----------------| |
| 36 | +|`[String]`|false |1 |false |ParameterSetName| |
26 | 37 |
|
27 | 38 |
|
28 | 39 |
|
29 |
| ---- |
30 | 40 | #### **Mandatory**
|
31 | 41 |
|
32 | 42 | If set, will mark this parameter as mandatory (within this parameter set).
|
33 | 43 |
|
34 | 44 |
|
35 | 45 |
|
36 |
| -> **Type**: ```[Switch]``` |
37 | 46 |
|
38 |
| -> **Required**: false |
39 | 47 |
|
40 |
| -> **Position**: named |
41 | 48 |
|
42 |
| -> **PipelineInput**:false |
| 49 | +|Type |Required|Position|PipelineInput| |
| 50 | +|----------|--------|--------|-------------| |
| 51 | +|`[Switch]`|false |named |false | |
43 | 52 |
|
44 | 53 |
|
45 | 54 |
|
46 |
| ---- |
47 | 55 | #### **ValueFromPipelineByPropertyName**
|
48 | 56 |
|
49 | 57 | If set, will also mark this parameter as taking ValueFromPipelineByPropertyName.
|
50 | 58 |
|
51 | 59 |
|
52 | 60 |
|
53 |
| -> **Type**: ```[Switch]``` |
54 | 61 |
|
55 |
| -> **Required**: false |
56 | 62 |
|
57 |
| -> **Position**: named |
58 | 63 |
|
59 |
| -> **PipelineInput**:false |
| 64 | +|Type |Required|Position|PipelineInput|Aliases | |
| 65 | +|----------|--------|--------|-------------|--------------| |
| 66 | +|`[Switch]`|false |named |false |VFPBPN<br/>VBN| |
60 | 67 |
|
61 | 68 |
|
62 | 69 |
|
63 |
| ---- |
64 | 70 | #### **Position**
|
65 | 71 |
|
66 | 72 | The position of the parameter.
|
67 | 73 |
|
68 | 74 |
|
69 | 75 |
|
70 |
| -> **Type**: ```[Int32]``` |
71 | 76 |
|
72 |
| -> **Required**: false |
73 | 77 |
|
74 |
| -> **Position**: 2 |
75 | 78 |
|
76 |
| -> **PipelineInput**:false |
| 79 | +|Type |Required|Position|PipelineInput| |
| 80 | +|---------|--------|--------|-------------| |
| 81 | +|`[Int32]`|false |2 |false | |
| 82 | + |
| 83 | + |
77 | 84 |
|
78 | 85 |
|
79 | 86 |
|
80 | 87 | ---
|
| 88 | + |
| 89 | + |
81 | 90 | ### Syntax
|
82 | 91 | ```PowerShell
|
83 | 92 | VFP [[-ParameterSet] <String>] [-Mandatory] [-ValueFromPipelineByPropertyName] [[-Position] <Int32>] [<CommonParameters>]
|
84 | 93 | ```
|
85 |
| ---- |
86 | 94 |
|
0 commit comments