Skip to content

Commit d136ba6

Browse files
StartAutomatingStartAutomating
authored andcommitted
Updating PipeScript.HelpOut.ps1 (#56)
1 parent 02eb83f commit d136ba6

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

docs/VFP.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
2+
VFP
3+
---
4+
### Synopsis
5+
ValueFromPipline Shorthand
6+
7+
---
8+
### Description
9+
10+
This is syntax shorthand to create [Parameter] attributes that take ValueFromPipeline.
11+
12+
---
13+
### Parameters
14+
#### **ParameterSet**
15+
16+
The parameter set name.
17+
18+
19+
20+
|Type |Requried|Postion|PipelineInput|
21+
|--------------|--------|-------|-------------|
22+
|```[String]```|false |1 |false |
23+
---
24+
#### **Mandatory**
25+
26+
If set, will mark this parameter as mandatory (within this parameter set).
27+
28+
29+
30+
|Type |Requried|Postion|PipelineInput|
31+
|--------------|--------|-------|-------------|
32+
|```[Switch]```|false |named |false |
33+
---
34+
#### **ValueFromPipelineByPropertyName**
35+
36+
If set, will also mark this parameter as taking ValueFromPipelineByPropertyName.
37+
38+
39+
40+
|Type |Requried|Postion|PipelineInput|
41+
|--------------|--------|-------|-------------|
42+
|```[Switch]```|false |named |false |
43+
---
44+
#### **Position**
45+
46+
The position of the parameter.
47+
48+
49+
50+
|Type |Requried|Postion|PipelineInput|
51+
|-------------|--------|-------|-------------|
52+
|```[Int32]```|false |2 |false |
53+
---
54+
### Syntax
55+
```PowerShell
56+
VFP [[-ParameterSet] <String>] [-Mandatory] [-ValueFromPipelineByPropertyName] [[-Position] <Int32>] [<CommonParameters>]
57+
```
58+
---
59+
60+

0 commit comments

Comments
 (0)