HelpersWriteChocolateySuccess.md

Write-ChocolateySuccess

DEPRECATED - DO NOT USE.

Syntax

Write-ChocolateySuccess `
  [-PackageName <String>] `
  [-IgnoredArguments <Object[]>] [<CommonParameters>]

Description

Writes a success message for a package.

Notes

This has been deprecated and is no longer useful as of 0.9.9. Instead please just use throw $_.Exception when catching errors. Although try/catch is no longer necessary unless you want to do some error handling.

Aliases

None

Inputs

None

Outputs

None

Parameters

-PackageName [<String>]

The name of the package - while this is an arbitrary value, it's recommended that it matches the package id.

Property	Value
Aliases
Required?	false
Position?	1
Default Value
Accept Pipeline Input?	false

-IgnoredArguments [<Object[]>]

Allows splatting with arguments that do not apply. Do not use directly.

Property	Value
Aliases
Required?	false
Position?	2
Default Value
Accept Pipeline Input?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters http://go.microsoft.com/fwlink/p/?LinkID=113216 .

Links

• [[Write-ChocolateyFailure|HelpersWriteChocolateyFailure]]

[[Function Reference|HelpersReference]]

NOTE: This documentation has been automatically generated from Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Write-ChocolateySuccess -Full.

View the source for Write-ChocolateySuccess