Write-Error

  • Referencia
Modul:
Microsoft.PowerShell.Utility

Objektumot ír a hibastreambe.

Syntax

Write-Error
     [-Message] <string>
     [-Category <ErrorCategory>]
     [-ErrorId <string>]
     [-TargetObject <Object>]
     [-RecommendedAction <string>]
     [-CategoryActivity <string>]
     [-CategoryReason <string>]
     [-CategoryTargetName <string>]
     [-CategoryTargetType <string>]
     [<CommonParameters>]
Write-Error
     [-Exception] <Exception>
     [-Message <string>]
     [-Category <ErrorCategory>]
     [-ErrorId <string>]
     [-TargetObject <Object>]
     [-RecommendedAction <string>]
     [-CategoryActivity <string>]
     [-CategoryReason <string>]
     [-CategoryTargetName <string>]
     [-CategoryTargetType <string>]
     [<CommonParameters>]
Write-Error
     [-ErrorRecord] <ErrorRecord>
     [-RecommendedAction <string>]
     [-CategoryActivity <string>]
     [-CategoryReason <string>]
     [-CategoryTargetName <string>]
     [-CategoryTargetType <string>]
     [<CommonParameters>]

Description

A Write-Error parancsmag nem végződő hibát deklarál. Alapértelmezés szerint a hibastreamben a rendszer hibaüzeneteket küld a megjelenítendő gazdaprogramnak a kimenettel együtt.

Ha nem végződő hibát szeretne írni, írjon be egy hibaüzenet-sztringet, egy ErrorRecord objektumot vagy egy kivételobjektumot . A hibarekord feltöltéséhez Write-Error használja a többi paramétert.

A nem végződő hibák hibát írnak a hibastreambe, de nem állnak le a parancsfeldolgozással. Ha a bemeneti elemek gyűjteményének egyik elemén nem végződő hiba van deklarálva, a parancs folytatja a gyűjtemény többi elemének feldolgozását.

A megszüntetési hiba deklarálásához használja a Throw kulcsszót. További információ: about_Throw.

Példák

1. példa: Hiba írása a RegistryKey-objektumhoz

Get-ChildItem | ForEach-Object {
    if ($_.GetType().ToString() -eq "Microsoft.Win32.RegistryKey")
    {
        Write-Error "Invalid object" -ErrorId B1 -TargetObject $_
    }
    else
    {
        $_
    }
}

Ez a parancs nem végződő hibát deklarál, ha a Get-ChildItem parancsmag egy Microsoft.Win32.RegistryKey objektumot ad vissza, például a PowerShell-beállításjegyzék-szolgáltató objektumait HKLM: vagy HKCU: meghajtóit.

2. példa: Hibaüzenet írása a konzolra

Write-Error "Access denied."

Ez a parancs deklarál egy nem végződő hibát, és "Hozzáférés megtagadva" hibaüzenetet ír. A parancs az Üzenet paramétert használja az üzenet megadásához, de kihagyja a választható Üzenet paraméternevet.

3. példa: Hiba írása a konzolra, és adja meg a kategóriát

Write-Error -Message "Error: Too many input values." -Category InvalidArgument

Ez a parancs deklarál egy nem végződő hibát, és egy hibakategóriát határoz meg.

4. példa: Hiba írása kivételobjektum használatával

$E = [System.Exception]@{Source="Get-ParameterNames.ps1";HelpLink="https://go.microsoft.com/fwlink/?LinkID=113425"}
Write-Error -Exception $E -Message "Files not found. The $Files location doesn't contain any XML files."

Ez a parancs kivételobjektum használatával deklarál egy nem végződő hibát.

Az első parancs kivonattáblát használ a System.Exception objektum létrehozásához. Menti a kivételobjektumot a $E változóban. Kivonattáblával bármilyen olyan objektumot létrehozhat, amely null konstruktort tartalmaz.

A második parancs a Write-Error parancsmaggal deklarál egy nem végződő hibát. A Kivétel paraméter értéke a változó Kivétel objektuma$E.

Paraméterek

-Category

A hiba kategóriáját adja meg. Az alapértelmezett érték nincs megadva. A paraméter elfogadható értékei a következők:

  • Nincs meghatározva
  • OpenError
  • CloseError
  • DeviceError
  • DeadlockDetected
  • InvalidArgument
  • InvalidData
  • InvalidOperation
  • InvalidResult
  • InvalidType
  • MetadataError
  • NotImplemented
  • NotInstalled
  • ObjectNotFound
  • OperationStopped
  • OperationTimeout
  • SyntaxError
  • ParserError
  • PermissionDenied
  • ResourceBusy
  • ResourceExists
  • ResourceUnavailable
  • ReadError
  • WriteError
  • FromStdErr
  • SecurityError
  • ProtocolError
  • Csatlakozás ionError
  • AuthenticationError
  • LimitExceeded
  • QuotaExceeded
  • NotEnabled

A hibakategóriákról további információt az ErrorCategory Enumerálás című témakörben talál.

Type:ErrorCategory
Accepted values:NotSpecified, OpenError, CloseError, DeviceError, DeadlockDetected, InvalidArgument, InvalidData, InvalidOperation, InvalidResult, InvalidType, MetadataError, NotImplemented, NotInstalled, ObjectNotFound, OperationStopped, OperationTimeout, SyntaxError, ParserError, PermissionDenied, ResourceBusy, ResourceExists, ResourceUnavailable, ReadError, WriteError, FromStdErr, SecurityError, ProtocolError, ConnectionError, AuthenticationError, LimitsExceeded, QuotaExceeded, NotEnabled
Position:Named
Default value:NotSpecified
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryActivity

Megadja a hibát okozó műveletet.

Type:String
Aliases:Activity
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryReason

Megadja, hogy a tevékenység hogyan vagy miért okozta a hibát.

Type:String
Aliases:Reason
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryTargetName

Megadja annak az objektumnak a nevét, amelyet a hiba bekövetkeztekor feldolgoztak.

Type:String
Aliases:TargetName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryTargetType

Megadja annak az objektumnak a típusát, amelyet a hiba bekövetkeztekor feldolgoztak.

Type:String
Aliases:TargetType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorId

Egy azonosító sztringet ad meg a hiba azonosításához. A sztringnek egyedinek kell lennie a hibához.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorRecord

A hibát jelző hibarekord-objektumot adja meg. A hiba leírásához használja az objektum tulajdonságait.

Hibarekord-objektum létrehozásához használja a New-Object parancsmagot, vagy kérje le a hibarekord objektumát a tömbből az $Error automatikus változóban.

Type:ErrorRecord
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Exception

A hibát jelképező kivételobjektumot adja meg. A hiba leírásához használja az objektum tulajdonságait.

Kivételobjektum létrehozásához használjon kivonattáblát, vagy használja a New-Object parancsmagot.

Type:Exception
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Message

A hiba üzenetszövegét adja meg. Ha a szöveg szóközöket vagy speciális karaktereket tartalmaz, akkor idézőjelek közé kell foglalnia. Üzenetsztringet is befűzhet a parancsba Write-Error.

Type:String
Aliases:Msg
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RecommendedAction

Megadja a felhasználó által a hiba elhárításához vagy megelőzéséhez szükséges műveletet.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetObject

A hiba bekövetkezésekor feldolgozott objektumot adja meg. Adja meg az objektumot, az objektumot tartalmazó változót vagy az objektumot lekérő parancsot.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Bevitelek

String

A parancsmagra egy hibaüzenetet tartalmazó sztringet csövezhet.

Kimenetek

None

Ez a parancsmag nem ad vissza kimenetet. Csak a hibaüzenet-adatfolyamba ír.

Jegyzetek

Write-Error nem módosítja az $? automatikus változó értékét, ezért nem jelez megszüntető hibafeltételt. A megszüntetési hiba jelzéséhez használja a $PSCmdlet.WriteError() metódust.