Skip to content

Commit

Permalink
Update docs and module help
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronparker committed Jan 23, 2023
1 parent b7ff984 commit d1669f0
Show file tree
Hide file tree
Showing 18 changed files with 80 additions and 275 deletions.
183 changes: 37 additions & 146 deletions VcRedist/en-US/VcRedist-help.xml

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/get-vclist.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ To return Redistributables from the list of unsupported Redistributables or the

## Filtering Output

The output from `Get-VcList` can be filtered before sending to other functions. `Get-VcList` has the `-Release` parameter for filtering on the `2005`, `2008`, `2010`, `2012`, `2013`, `2015`, `2017`, `2019` and `2022` releases of the Redistributables. Additionally, the `-Architecture` parameter can filter on `x86` and `x64` processor architectures.
The output from `Get-VcList` can be filtered before sending to other functions. `Get-VcList` has the `-Release` parameter for filtering on the `2012`, `2013`, `2015`, `2017`, `2019` and `2022` releases of the Redistributables. Additionally, the `-Architecture` parameter can filter on `x86` and `x64` processor architectures.

These parameters cannot be used with the `-Export` parameter. If you require filtering when exporting All, Supported or Unsupported Redistributables, pipe the output to the `Where-Object` function.
These parameters cannot be used with the `-Export` parameter. If you require filtering when exporting All, Supported or Unsupported Redistributables, pipe the output to the `Where-Object` function. This approach is required where you want to export a list of the unsupported Redistributables.

## Examples

Expand Down Expand Up @@ -133,8 +133,8 @@ You may want to export the complete list of available supported and unsupported
Get-VcList -Export All | Where-Object { $_.Architecture -eq "x64" }
```

To return a specific release and architecture from the list of unsupported Visual C++ Redistributables from the embedded manifest, the following can be used to filter for the `2008`, 64-bit versions of the Redistributables.
To return a specific release and architecture from the list of unsupported Visual C++ Redistributables from the embedded manifest, the following can be used to filter for the `2008`, and `2010` releases and 64-bit versions of the Redistributables.

```powershell
Get-VcList -Export Unsupported | Where-Object { $_.Release -eq "2008" -and $_.Architecture -eq "x64" }
Get-VcList -Export Unsupported | Where-Object { $_.Release -in "2008", "2010" -and $_.Architecture -eq "x64" }
```
4 changes: 2 additions & 2 deletions docs/help/en-US/Export-VcManifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ This enables editing of the JSON manifest for custom scenarios.
### EXAMPLE 1

```powershell
Export-VcManifest -Path "C:\Temp\VisualCRedistributablesSupported.json"
Export-VcManifest -Path "C:\Temp"
```

Description:
Export the list of supported Visual C++ Redistributables to C:\Temp\VisualCRedistributablesSupported.json.
Export the list of supported Visual C++ Redistributables to C:\Temp\VisualCRedistributables.json.

## PARAMETERS

Expand Down
4 changes: 2 additions & 2 deletions docs/help/en-US/Get-VcList.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Get-VcList
```

Description:
Returns the supported 2010, 2012, 2013 and 2019, x86 and x64 versions of the supported Visual C++ Redistributables from the embedded manifest.
Returns the supported 2012, 2013 and 2022, x86 and x64 versions of the supported Visual C++ Redistributables from the embedded manifest.

### EXAMPLE 3

Expand Down Expand Up @@ -114,7 +114,7 @@ Aliases:

Required: False
Position: 1
Default value: @("2010", "2012", "2013", "2019")
Default value: @("2012", "2013", "2022")
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
29 changes: 6 additions & 23 deletions docs/help/en-US/Import-VcConfigMgrApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Creates Visual C++ Redistributable applications in a ConfigMgr site.
## SYNTAX

```
Import-VcConfigMgrApplication [-VcList] <PSObject> [-Path] <String> [-CMPath] <String> [-SMSSiteCode] <String>
[[-AppFolder] <String>] [-Silent] [-NoCopy] [[-Publisher] <String>] [[-Keyword] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Import-VcConfigMgrApplication [-VcList] <PSObject> [[-CMPath] <String>
[-SMSSiteCode] <String> [[-AppFolder] <String>] [-Silent] [-NoCopy] [[-Publisher] <String>]
[[-Keyword] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -54,9 +54,8 @@ Detection method: (Registry path)
### EXAMPLE 1

```powershell
$VcList = Get-VcList
Save-VcRedist -VcList $VcList -Path "C:\Temp\VcRedist"
Import-VcConfigMgrApplication -VcList $VcList -Path "C:\Temp\VcRedist" -CMPath "\\server\share\VcRedist" -SMSSiteCode LAB
$VcList = Get-VcList | Save-VcRedist -Path "C:\Temp\VcRedist"
Import-VcConfigMgrApplication -VcList $VcList -CMPath "\\server\share\VcRedist" -SMSSiteCode LAB
```

Description:
Expand All @@ -66,7 +65,7 @@ Download the supported Visual C++ Redistributables to "C:\Temp\VcRedist", copy t

### -VcList

An array containing details of the Visual C++ Redistributables from Get-VcList.
An array containing details of the Visual C++ Redistributables from Save-VcRedist. Save-VcRedist adds the Path property, that points to the installer executable, to the array exported from Get-VcList.

```yaml
Type: PSObject
Expand All @@ -80,22 +79,6 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -Path
A folder containing the downloaded Visual C++ Redistributables.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -CMPath
Specify a UNC path where the Visual C++ Redistributables will be distributed from
Expand Down
5 changes: 2 additions & 3 deletions docs/help/en-US/Import-VcIntuneApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ This function requires the IntuneWin32App PowerShell module and supported Window

```powershell
Connect-MSIntuneGraph -TenantID contoso.onmicrosoft.com
$Vc = Get-VcList -Release "2022"
$VcList = Save-VcRedist -VcList $Vc -Path C:\Temp\VcRedist
$VcList = Get-VcList -Release "2022" | Save-VcRedist -Path "C:\Temp\VcRedist"
Import-VcIntuneApplication -VcList $VcList
```

Expand All @@ -45,7 +44,7 @@ Authenticates to the specified tenant, retrieves the list of Visual C++ Redistri

```powershell
Connect-MSIntuneGraph -TenantID contoso.onmicrosoft.com -ClientId "f99877d5-f757-438e-b12b-d905b00ea6f3" -ClientSecret <secret>
Get-VcList | Save-VcRedist | Import-VcIntuneApplication
Get-VcList | Save-VcRedist -Path "C:\Temp\VcRedist" | Import-VcIntuneApplication
```

Description:
Expand Down
26 changes: 4 additions & 22 deletions docs/help/en-US/Import-VcMdtApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Creates Visual C++ Redistributable applications in a Microsoft Deployment Toolki
## SYNTAX

```
Import-VcMdtApplication [-VcList] <PSObject> [-Path] <String> [-MdtPath] <String> [[-AppFolder] <String>]
Import-VcMdtApplication [-VcList] <PSObject> [[-MdtPath] <String> [[-AppFolder] <String>]
[-Silent] [-DontHide] [-Force] [[-MdtDrive] <String>] [[-Publisher] <String>] [[-Language] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
Expand Down Expand Up @@ -54,9 +54,8 @@ Retrieves the list of Visual C++ Redistributables, downloads them to C:\Temp\VcR
### EXAMPLE 2

```powershell
$VcList = Get-VcList -ExportAll
Save-VcRedist -VcList $VcList -Path C:\Temp\VcRedist
Import-VcMdtApplication -VcList $VcList -Path C:\Temp\VcRedist -MdtPath \\server\deployment -Bundle
$VcList = Get-VcList -ExportAll | Save-VcRedist -Path C:\Temp\VcRedist
Import-VcMdtApplication -VcList $VcList -MdtPath \\server\deployment -Bundle
```

Description:
Expand All @@ -66,7 +65,7 @@ Retrieves the list of supported and unsupported Visual C++ Redistributables in t

### -VcList

An array containing details of the Visual C++ Redistributables from Get-VcList.
An array containing details of the Visual C++ Redistributables from Save-VcRedist. Save-VcRedist adds the Path property, that points to the installer executable, to the array exported from Get-VcList.

```yaml
Type: PSObject
Expand All @@ -80,22 +79,6 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -Path
A folder containing the downloaded Visual C++ Redistributable binaries.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MdtPath
The local or network path to the MDT deployment share.
Expand Down Expand Up @@ -260,7 +243,6 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
27 changes: 5 additions & 22 deletions docs/help/en-US/Install-VcRedist.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Installs the Visual C++ Redistributables on the local system.
## SYNTAX

```
Install-VcRedist [-VcList] <PSObject> [[-Path] <String>] [-Silent] [-Force] [-WhatIf] [-Confirm]
Install-VcRedist [-VcList] <PSObject> [[-Silent] [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
```

Expand All @@ -37,7 +37,7 @@ Installs the 2013 and 2019 64-bit Visual C++ Redistributables listed in $VcRedis
### EXAMPLE 2

```powershell
$VcRedists = Get-VcList -Release "2012","2013",2017" -Architecture x64
$VcRedists = Get-VcList -Release "2012","2013","2017" -Architecture x64
Install-VcRedist -VcList $VcRedists -Path C:\Temp\VcRedists
```

Expand All @@ -47,8 +47,8 @@ Installs only the 64-bit 2012, 2013 and 2017 Visual C++ Redistributables listed
### EXAMPLE 3

```powershell
$VcRedists = Get-VcList -Release "2012","2013",2017" -Architecture x64
Install-VcRedist -VcList $VcRedists -Path C:\Temp\VcRedists -Silent
$VcRedists = Get-VcList -Release "2012","2013","2017" -Architecture x64 | Save-VcRedist -Path C:\Temp\VcRedists
Install-VcRedist -VcList $VcRedists -Silent
```

Description:
Expand All @@ -58,7 +58,7 @@ Installs all supported Visual C++ Redistributables using a completely silent ins

### -VcList

An array containing details of the Visual C++ Redistributables from Get-VcList.
An array containing details of the Visual C++ Redistributables from Save-VcRedist. Save-VcRedist adds the Path property, that points to the installer executable, to the array exported from Get-VcList.

```yaml
Type: PSObject
Expand All @@ -72,22 +72,6 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -Path
A path to the folder containing the downloaded Visual C++ Redistributables.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: (Resolve-Path -Path $PWD)
Accept pipeline input: False
Accept wildcard characters: False
```
### -Silent
Perform a completely silent install of the VcRedist with no UI.
Expand Down Expand Up @@ -155,7 +139,6 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
7 changes: 3 additions & 4 deletions docs/help/en-US/New-VcMdtBundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Dependencies: (VcRedists in the MDT share)
### EXAMPLE 1

```powershell
Get-VcList | Save-VcRedist -Path C:\Temp\VcRedist | Import-VcMdtApp -Path C:\Temp\VcRedist -MdtPath \\server\deployment
Get-VcList | Save-VcRedist -Path C:\Temp\VcRedist | Import-VcMdtApplication -Path C:\Temp\VcRedist -MdtPath \\server\deployment
```

Description:
Expand All @@ -51,9 +51,8 @@ Retrieves the list of Visual C++ Redistributables, downloads them to C:\Temp\VcR
### EXAMPLE 2

```powershell
$VcList = Get-VcList -ExportAll
Save-VcRedist -VcList $VcList -Path C:\Temp\VcRedist
Import-VcMdtApp -VcList $VcList -Path C:\Temp\VcRedist -MdtPath \\server\deployment -Bundle
$VcList = Get-VcList -ExportAll | Save-VcRedist -Path C:\Temp\VcRedist
Import-VcMdtApplication -VcList $VcList -MdtPath \\server\deployment -Bundle
```

Description:
Expand Down
5 changes: 2 additions & 3 deletions docs/help/en-US/Save-VcRedist.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ schema: 2.0.0

## SYNOPSIS

Downloads the Visual C++ Redistributables from an manifest returned by Get-VcList.
Downloads the Visual C++ Redistributables from an manifest returned by Get-VcList. The output from Get-VcList is modified by adding the path to the Redistributable installer in the Path property. This output can then be passed to other functions that require the downloaded installer.

## SYNTAX

Expand All @@ -21,8 +21,7 @@ Save-VcRedist [-VcList] <PSObject> [[-Path] <String>] [-ForceWebRequest] [-Prior

## DESCRIPTION

Downloads the Visual C++ Redistributables from an manifest returned by Get-VcList into a folder structure that represents release, version and processor architecture.
If the redistributable exists in the specified path, it will not be re-downloaded.
Downloads the Visual C++ Redistributables from an manifest returned by Get-VcList into a folder structure that represents release, version and processor architecture. If the redistributable exists in the specified path, it will not be re-downloaded.

For example, the following folder structure will be created when downloading the 2010, 2012, 2013 and 2019 Redistributables to C:\VcRedist:

Expand Down
23 changes: 6 additions & 17 deletions docs/help/en-US/Test-VcListUri.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ Tests that the downloads for the Visual C++ Redistributables as listed in the ma
## SYNTAX

```
Test-VcRedistUri [-VcList] <PSObject> [[-Path] <String>] [-Priority <String>]
[[-Proxy] <String>] [[-ProxyCredential] <PSCredential>] [-UserAgent <String>] [-ShowProgress] [-WhatIf]
[-Confirm] [<CommonParameters>]
Test-VcRedistUri [-VcList] <PSObject> [[-Proxy] <String>] [[-ProxyCredential] <PSCredential>] [-ShowProgress]
[-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -149,22 +148,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -UserAgent
Specifies a user agent string for the web request.
The default user agent is similar to the below with slight variations for each operating system and platform.
Mozilla/5.0 (Macintosh; Darwin 22.2.0 Darwin Kernel Version 22.2.0: Fri Nov 11 02:04:44 PST 2022; root:xnu-8792.61.2~4/RELEASE_ARM64_T8103; en-AU) AppleWebKit/534.6 (KHTML, like Gecko) Chrome/7.0.500.0 Safari/534.6
To test a website with the standard user agent string that's used by most internet browsers, use the properties of the PSUserAgent class, such as Chrome, FireFox, InternetExplorer, Opera, and Safari.
For example, the following command uses the user agent string for Internet Explorer: Save-EvergreenApp -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer)
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf

Required: False
Position: Named
Expand All @@ -174,7 +164,6 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
3 changes: 0 additions & 3 deletions docs/help/en-US/Uninstall-VcRedist.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,12 @@ Uninstall the installed Visual C++ Redistributables on the local system.
## SYNTAX

### Manual (Default)

```
Uninstall-VcRedist [[-Release] <String[]>] [[-Architecture] <String[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```

### Pipeline

```
Uninstall-VcRedist [-VcList] <PSObject> [-WhatIf] [-Confirm] [<CommonParameters>]
```
Expand Down Expand Up @@ -144,7 +142,6 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
Loading

0 comments on commit d1669f0

Please sign in to comment.