Skip to content

Commit a5e159c

Browse files
StartAutomatingStartAutomating
authored andcommitted
Join-PipeScript: Improving Unnamed end block behavior (Fixes #363)
1 parent 7b1dad6 commit a5e159c

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

docs/VFP.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,94 @@
11
VFP
22
---
3+
4+
5+
6+
37
### Synopsis
48
ValueFromPipline Shorthand
59

10+
11+
612
---
13+
14+
715
### Description
816

917
This is syntax shorthand to create [Parameter] attributes that take ValueFromPipeline.
1018

19+
20+
1121
---
22+
23+
1224
### Parameters
1325
#### **ParameterSet**
1426

1527
The parameter set name.
1628

1729

1830

19-
> **Type**: ```[String]```
2031

21-
> **Required**: false
2232

23-
> **Position**: 1
2433

25-
> **PipelineInput**:false
34+
|Type |Required|Position|PipelineInput|Aliases |
35+
|----------|--------|--------|-------------|----------------|
36+
|`[String]`|false |1 |false |ParameterSetName|
2637

2738

2839

29-
---
3040
#### **Mandatory**
3141

3242
If set, will mark this parameter as mandatory (within this parameter set).
3343

3444

3545

36-
> **Type**: ```[Switch]```
3746

38-
> **Required**: false
3947

40-
> **Position**: named
4148

42-
> **PipelineInput**:false
49+
|Type |Required|Position|PipelineInput|
50+
|----------|--------|--------|-------------|
51+
|`[Switch]`|false |named |false |
4352

4453

4554

46-
---
4755
#### **ValueFromPipelineByPropertyName**
4856

4957
If set, will also mark this parameter as taking ValueFromPipelineByPropertyName.
5058

5159

5260

53-
> **Type**: ```[Switch]```
5461

55-
> **Required**: false
5662

57-
> **Position**: named
5863

59-
> **PipelineInput**:false
64+
|Type |Required|Position|PipelineInput|Aliases |
65+
|----------|--------|--------|-------------|--------------|
66+
|`[Switch]`|false |named |false |VFPBPN<br/>VBN|
6067

6168

6269

63-
---
6470
#### **Position**
6571

6672
The position of the parameter.
6773

6874

6975

70-
> **Type**: ```[Int32]```
7176

72-
> **Required**: false
7377

74-
> **Position**: 2
7578

76-
> **PipelineInput**:false
79+
|Type |Required|Position|PipelineInput|
80+
|---------|--------|--------|-------------|
81+
|`[Int32]`|false |2 |false |
82+
83+
7784

7885

7986

8087
---
88+
89+
8190
### Syntax
8291
```PowerShell
8392
VFP [[-ParameterSet] <String>] [-Mandatory] [-ValueFromPipelineByPropertyName] [[-Position] <Int32>] [<CommonParameters>]
8493
```
85-
---
8694

0 commit comments

Comments
 (0)