Share via


Vanliga parameternamn

Parametrarna som beskrivs i det här avsnittet kallas för vanliga parametrar. De läggs till i cmdlets av Windows PowerShell runtime och kan inte deklareras av cmdleten.

Anteckning

Dessa parametrar läggs också till i provider-cmdletarna och i funktioner som är färgade med CmdletBinding attributet .

Allmänna vanliga parametrar

Följande parametrar läggs till i alla cmdlets och kan nås när cmdleten körs. Dessa parametrar definieras av klassen System.Management.Automation.Internal.Commonparameters.

Bekräfta (alias: cf)

Datatyp: SwitchParameter

Den här parametern anger om cmdleten visar en uppmaning som frågar om användaren är säker på att han eller hon vill fortsätta.

Felsöka (alias: db)

Datatyp: SwitchParameter

Den här parametern anger om felsökningsmeddelanden på programnivå som kan visas på kommandoraden. Dessa meddelanden är avsedda för felsökning av cmdlet-åtgärden och genereras av anrop till metoden System.Management.Automation.Cmdlet.WriteDebug. Felsökningsmeddelanden behöver inte lokaliseras.

ErrorAction (alias: ea)

Datatyp: Uppräkning

Den här parametern anger vilken åtgärd som ska vidtas när ett fel inträffar. Möjliga värden för den här parametern definieras av uppräkningen System.Management.Automation.Actionpreference.

ErrorVariable (alias: ev)

Datatyp: Sträng

Den här parametern anger variabeln där objekt ska placera ut när ett fel inträffar. Om du vill lägga till i den här variabeln använder du +varname i stället för att rensa och ange variabeln.

OutBuffer (alias: ob)

Datatyp: Int32

Den här parametern definierar antalet objekt som ska lagras i utdatabufferten innan några objekt skickas nedåt i pipelinen. Som standard skickas objekt direkt nedåt i pipelinen.

OutVariable (alias: ov)

Datatyp: Sträng

Den här parametern anger variabeln där alla utdataobjekt som genereras av cmdleten ska placeras. Om du vill lägga till i den här variabeln använder du +varname i stället för att rensa och ange variabeln.

PipelineVariable (alias: pv)

Datatyp: Sträng

Den här parametern lagrar värdet för det aktuella pipelineelementet som en variabel för ett namngivet kommando när det flödar genom pipelinen.

Utförlig (alias: vb)

Datatyp: SwitchParameter

Den här parametern anger om cmdleten skriver förklarande meddelanden som kan visas på kommandoraden. Dessa meddelanden är avsedda att ge ytterligare hjälp till användaren och genereras av anrop till metoden System.Management.Automation.Cmdlet.WriteVerbose.

WarningAction (alias: wa)

Datatyp: Uppräkning

Den här parametern anger vilken åtgärd som ska ske när cmdleten skriver ett varningsmeddelande. Möjliga värden för den här parametern definieras av uppräkningen System.Management.Automation.Actionpreference.

WarningVariable (alias: wv)

Datatyp: Sträng

Den här parametern anger variabeln där varningsmeddelanden kan sparas. Om du vill lägga till i den här variabeln använder du +varname i stället för att rensa och ange variabeln.

Risk-Mitigation parametrar

Följande parametrar läggs till i cmdlets som begär bekräftelse innan de utför åtgärden. Mer information om bekräftelsebegäranden finns i Begära bekräftelse. Dessa parametrar definieras av klassen System.Management.Automation.Internal.Shouldprocessparameters.

WhatIf (alias: wi)

Datatyp: SwitchParameter

Den här parametern anger om cmdleten skriver ett meddelande som beskriver effekterna av att köra cmdleten utan att faktiskt utföra någon åtgärd.

Transaktionsparametrar

Följande parameter läggs till i cmdlets som stöder transaktioner. Dessa parametrar definieras av klassen System.Management.Automation.Internal.Transactionparameters. Transaktionsstöd introducerades i PowerShell 3.0 och upphörde i PowerShell 6.0.

UseTransaction (alias: usetx)

Datatyp: SwitchParameter

Den här parametern anger om cmdleten ska använda den aktuella transaktionen för att utföra åtgärden.

Se även

System.Management.Automation.Internal.Commonparameters

System.Management.Automation.Internal.Shouldprocessparameters

System.Management.Automation.Internal.Transactionparameters

Skriva en Windows PowerShell-cmdlet

Windows PowerShell SDK