Informationen zu Functions

Artikel
05/09/2024

Kurze Beschreibung

Beschreibt, wie Funktionen in PowerShell erstellt und verwendet werden.

Lange Beschreibung

Eine Funktion ist eine Liste von PowerShell-Anweisungen, die über einen von Ihnen zugewiesenen Namen verfügen. Wenn Sie eine Funktion ausführen, geben Sie den Funktionsnamen ein. Die Anweisungen in der Liste werden so ausgeführt, als hätten Sie sie an der Eingabeaufforderung eingegeben.

Funktionen können so einfach sein wie:

function Get-PowerShellProcess { Get-Process PowerShell }

Eine Funktion kann auch so komplex sein wie ein Cmdlet oder ein Anwendungsprogramm.

Wie Cmdlets können Funktionen Parameter aufweisen. Die Parameter können benannt, positional, switch oder dynamische Parameter sein. Funktionsparameter können aus der Befehlszeile oder aus der Pipeline gelesen werden.

Funktionen können Werte zurückgeben, die angezeigt, Variablen zugewiesen oder an andere Funktionen oder Cmdlets übergeben werden können. Sie können auch einen Rückgabewert mithilfe des return Schlüsselwort (keyword) angeben. Die return Schlüsselwort (keyword) wirkt sich nicht auf andere von Ihrer Funktion zurückgegebene Ausgabe aus oder unterdrückt sie nicht. Die return Schlüsselwort (keyword) beendet jedoch die Funktion an dieser Zeile. Weitere Informationen finden Sie unter about_Return.

Die Anweisungsliste der Funktion kann verschiedene Typen von Anweisungslisten mit den Schlüsselwörtern Begin, Processund Endenthalten. Diese Anweisungslisten behandeln Eingaben aus der Pipeline unterschiedlich.

Ein Filter ist eine spezielle Art von Funktion, die die Filter Schlüsselwort (keyword) verwendet.

Funktionen können auch wie Cmdlets fungieren. Sie können eine Funktion erstellen, die wie ein Cmdlet funktioniert, ohne programmieren zu müssen C# . Weitere Informationen finden Sie unter about_Functions_Advanced.

Syntax

Es folgt die Syntax für eine Funktion:

function [<scope:>]<name> [([type]$parameter1[,[type]$parameter2])]
{
  param([type]$parameter1 [,[type]$parameter2])
  dynamicparam {<statement list>}
  begin {<statement list>}
  process {<statement list>}
  end {<statement list>}
}

Eine Funktion enthält die folgenden Elemente:

Ein Function Schlüsselwort (keyword)
Ein Bereich (optional)
Ein von Ihnen ausgewählter Name
Beliebig viele benannte Parameter (optional)
Mindestens ein PowerShell-Befehl, der in Klammern eingeschlossen ist {}

Weitere Informationen zu den Dynamicparam Schlüsselwort (keyword) und dynamischen Parametern in Funktionen finden Sie unter about_Functions_Advanced_Parameters.

Einfache Funktionen

Funktionen müssen nicht kompliziert sein, um nützlich zu sein. Die einfachsten Funktionen haben das folgende Format:

function <function-name> {statements}

Beispielsweise startet die folgende Funktion PowerShell mit der Option Als Administrator ausführen.

function Start-PSAdmin {Start-Process PowerShell -Verb RunAs}

Geben Sie Folgendes ein, um die Funktion zu verwenden: Start-PSAdmin

Um der Funktion Anweisungen hinzuzufügen, geben Sie jede Anweisung in eine separate Zeile ein, oder verwenden Sie ein Semikolon ; , um die Anweisungen zu trennen.

Beispielsweise findet die folgende Funktion alle .jpg Dateien in den Verzeichnissen des aktuellen Benutzers, die nach dem Startdatum geändert wurden.

function Get-NewPix
{
  $start = Get-Date -Month 1 -Day 1 -Year 2010
  $allpix = Get-ChildItem -Path $env:UserProfile\*.jpg -Recurse
  $allpix | Where-Object {$_.LastWriteTime -gt $Start}
}

Sie können eine Toolbox mit nützlichen kleinen Funktionen erstellen. Fügen Sie diese Funktionen Ihrem PowerShell-Profil hinzu, wie in about_Profiles und höher in diesem Thema beschrieben.

Funktionsnamen

Sie können einer Funktion einen beliebigen Namen zuweisen, aber Funktionen, die Sie für andere freigeben, sollten den Benennungsregeln folgen, die für alle PowerShell-Befehle eingerichtet wurden.

Funktionsnamen sollten aus einem Verb-Nomen-Paar bestehen, in dem das Verb die Aktion identifiziert, die von der Funktion ausgeführt wird, und das Substantiv das Element identifiziert, für das das Cmdlet seine Aktion ausführt.

Funktionen sollten die Standardverben verwenden, die für alle PowerShell-Befehle genehmigt wurden. Diese Verben helfen uns, unsere Befehlsnamen einfach, konsistent und für Benutzer verständlich zu halten.

Weitere Informationen zu den PowerShell-Standardverben finden Sie unter Genehmigte Verben im Microsoft-Dokumentation.

Funktionen mit Parametern

Sie können Parameter mit Funktionen verwenden, einschließlich benannter Parameter, Positionsparameter, Schalterparameter und dynamischer Parameter. Weitere Informationen zu dynamischen Parametern in Funktionen finden Sie unter about_Functions_Advanced_Parameters.

benannten Parametern

Sie können eine beliebige Anzahl benannter Parameter definieren. Sie können einen Standardwert für benannte Parameter einschließen, wie weiter unten in diesem Thema beschrieben.

Sie können Parameter innerhalb der Klammern mithilfe der Param Schlüsselwort (keyword) definieren, wie in der folgenden Beispielsyntax gezeigt:

function <name> {
  param ([type]$parameter1[,[type]$parameter2])
  <statement list>
}

Sie können auch Parameter außerhalb der Klammern ohne die Param Schlüsselwort (keyword) definieren, wie in der folgenden Beispielsyntax gezeigt:

function <name> [([type]$parameter1[,[type]$parameter2])] {
  <statement list>
}

Im Folgenden finden Sie ein Beispiel für diese alternative Syntax.

Function Add-Numbers($one, $two) {
    $one + $two
}

Während die erste Methode bevorzugt wird, gibt es keinen Unterschied zwischen diesen beiden Methoden.

Wenn Sie die Funktion ausführen, wird der Wert, den Sie für einen Parameter angeben, einer Variablen zugewiesen, die den Parameternamen enthält. Der Wert dieser Variablen kann in der Funktion verwendet werden.

Das folgende Beispiel ist eine Funktion namens Get-SmallFiles. Diese Funktion verfügt über einen $Size Parameter. Die Funktion zeigt alle Dateien an, die kleiner als der Wert des $Size Parameters sind, und schließt Verzeichnisse aus:

function Get-SmallFiles {
  Param($Size)
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

In der Funktion können Sie die $Size Variable verwenden. Dies ist der für den Parameter definierte Name.

Geben Sie den folgenden Befehl ein, um diese Funktion zu verwenden:

Get-SmallFiles -Size 50

Sie können auch einen Wert für einen benannten Parameter ohne den Parameternamen eingeben. Der folgende Befehl liefert beispielsweise das gleiche Ergebnis wie ein Befehl, der den Parameter Size benennt:

Get-SmallFiles 50

Um einen Standardwert für einen Parameter zu definieren, geben Sie ein Gleichheitszeichen und den Wert nach dem Parameternamen ein, wie in der folgenden Variante des Beispiels Get-SmallFiles gezeigt:

function Get-SmallFiles ($Size = 100) {
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

Wenn Sie ohne Wert eingeben Get-SmallFiles , weist die Funktion 100 zu $size. Wenn Sie einen Wert angeben, verwendet die Funktion diesen Wert.

Optional können Sie eine kurze Hilfezeichenfolge bereitstellen, die den Standardwert Ihres Parameters beschreibt, indem Sie der Beschreibung Ihres Parameters das PSDefaultValue-Attribut hinzufügen und die Help-Eigenschaft von PSDefaultValue angeben. Um eine Hilfezeichenfolge bereitzustellen, die den Standardwert (100) des Size-Parameters in der Get-SmallFiles Funktion beschreibt, fügen Sie das PSDefaultValue-Attribut hinzu, wie im folgenden Beispiel gezeigt.

function Get-SmallFiles {
  param (
      [PSDefaultValue(Help = '100')]
      $Size = 100
  )
}

Weitere Informationen zur PSDefaultValue-Attributklasse finden Sie unter PSDefaultValue-Attributmember.

Positionsparameter

Ein Positionsparameter ist ein Parameter ohne Parameternamen. PowerShell verwendet die Parameterwertreihenfolge, um jeden Parameterwert einem Parameter in der Funktion zuzuordnen.

Wenn Sie Positionsparameter verwenden, geben Sie einen oder mehrere Werte nach dem Funktionsnamen ein. Positionsparameterwerte werden der $args Arrayvariablen zugewiesen. Der Wert, der auf den Funktionsnamen folgt, wird der ersten Position im $args Array zugewiesen, $args[0].

Die folgende Get-Extension Funktion fügt die .txt Dateinamenerweiterung einem von Ihnen angegebenen Dateinamen hinzu:

function Get-Extension {
  $name = $args[0] + ".txt"
  $name
}

Get-Extension myTextFile

myTextFile.txt

Parameter wechseln

Ein Switch ist ein Parameter, der keinen Wert erfordert. Geben Sie stattdessen den Funktionsnamen gefolgt vom Namen des Switch-Parameters ein.

Um einen Switch-Parameter zu definieren, geben Sie den Typ [switch] vor dem Parameternamen an, wie im folgenden Beispiel gezeigt:

function Switch-Item {
  param ([switch]$on)
  if ($on) { "Switch on" }
  else { "Switch off" }
}

Wenn Sie den On Switch-Parameter nach dem Funktionsnamen eingeben, zeigt die Funktion "Einschalten" an. Ohne den Switch-Parameter wird "Ausschalten" angezeigt.

Switch-Item -on

Switch on

Switch-Item

Switch off

Sie können einem Switch auch einen booleschen Wert zuweisen, wenn Sie die Funktion ausführen, wie im folgenden Beispiel gezeigt:

Switch-Item -on:$true

Switch on

Switch-Item -on:$false

Switch off

Verwenden von Splatting zum Darstellen von Befehlsparametern

Sie können splatting verwenden, um die Parameter eines Befehls darzustellen. Dieses Feature wird in Windows PowerShell 3.0 eingeführt.

Verwenden Sie dieses Verfahren in Funktionen, die Befehle in der Sitzung aufrufen. Sie müssen die Befehlsparameter nicht deklarieren oder auflisten oder die Funktion ändern, wenn sich die Befehlsparameter ändern.

Die folgende Beispielfunktion ruft das Get-Command Cmdlet auf. Der Befehl verwendet @Args , um die Parameter von Get-Commanddarzustellen.

function Get-MyCommand { Get-Command @Args }

Sie können alle Parameter von Get-Command verwenden, wenn Sie die Get-MyCommand Funktion aufrufen. Die Parameter und Parameterwerte werden mithilfe @Argsvon an den Befehl übergeben.

Get-MyCommand -Name Get-ChildItem

CommandType     Name                ModuleName
-----------     ----                ----------
Cmdlet          Get-ChildItem       Microsoft.PowerShell.Management

Das @Args Feature verwendet den $Args automatischen Parameter, der nicht deklarierte Cmdletparameter und Werte aus verbleibenden Argumenten darstellt.

Weitere Informationen zum Splatting finden Sie unter about_Splatting.

Piping von Objekten an Funktionen

Jede Funktion kann Eingaben aus der Pipeline übernehmen. Sie können steuern, wie eine Funktion Eingaben aus der Pipeline verarbeitet, indem BeginSie schlüsselwörter , Processund End verwenden. Die folgende Beispielsyntax zeigt die drei Schlüsselwörter:

function <name> {
  begin {<statement list>}
  process {<statement list>}
  end {<statement list>}
}

Die Begin Anweisungsliste wird nur einmal am Anfang der Funktion ausgeführt.

Wichtig

Wenn Ihre Funktion einen Begin- Process oder End -Block definiert, muss sich der gesamte Code in diesen Blöcken befinden. Außerhalb der Blöcke wird kein Code erkannt, wenn einer der Blöcke definiert ist.

Die Process Anweisungsliste wird für jedes Objekt in der Pipeline einmal ausgeführt. Während der Ausführung des Process Blocks wird jedes Pipelineobjekt der $_ automatischen Variablen zugewiesen, jeweils ein Pipelineobjekt.

Nachdem die Funktion alle Objekte in der Pipeline empfangen hat, wird die Anweisungsliste End einmal ausgeführt. Wenn keine BeginSchlüsselwörter , Processoder End verwendet werden, werden alle Anweisungen wie eine Anweisungsliste End behandelt.

Die folgende Funktion verwendet die Process Schlüsselwort (keyword). Die Funktion zeigt Beispiele aus der Pipeline an:

function Get-Pipeline
{
  process {"The value is: $_"}
}

Um diese Funktion zu veranschaulichen, geben Sie eine Durch kommas getrennte Liste von Zahlen ein, wie im folgenden Beispiel gezeigt:

1,2,4 | Get-Pipeline

The value is: 1
The value is: 2
The value is: 4

Wenn Sie eine Funktion in einer Pipeline verwenden, werden die Objekte, die an die Funktion übergeben werden, der $input automatischen Variablen zugewiesen. Die Funktion führt Anweisungen mit dem Begin Schlüsselwort (keyword) aus, bevor Objekte aus der Pipeline stammen. Die Funktion führt Anweisungen mit dem End Schlüsselwort (keyword) aus, nachdem alle Objekte von der Pipeline empfangen wurden.

Das folgende Beispiel zeigt die $input automatische Variable mit Begin und End Schlüsselwörtern.

function Get-PipelineBeginEnd
{
  begin {"Begin: The input is $input"}
  end {"End:   The input is $input" }
}

Wenn diese Funktion mithilfe der Pipeline ausgeführt wird, werden die folgenden Ergebnisse angezeigt:

1,2,4 | Get-PipelineBeginEnd

Begin: The input is
End:   The input is 1 2 4

Wenn die Begin -Anweisung ausgeführt wird, verfügt die Funktion nicht über die Eingabe aus der Pipeline. Die End -Anweisung wird ausgeführt, nachdem die Funktion über die Werte verfügt.

Wenn die Funktion über einen Process Schlüsselwort (keyword) verfügt, wird jedes Objekt in $input aus $input entfernt und zugewiesen$_. Das folgende Beispiel enthält eine Anweisungsliste Process :

function Get-PipelineInput
{
  process {"Processing:  $_ " }
  end {"End:   The input is: $input" }
}

In diesem Beispiel wird jedes Objekt, das an die Funktion übergeben wird, an die Anweisungsliste Process gesendet. Die Process Anweisungen werden für jedes Objekt ausgeführt, jeweils ein Objekt. Die $input automatische Variable ist leer, wenn die Funktion den End Schlüsselwort (keyword) erreicht.

1,2,4 | Get-PipelineInput

Processing:  1
Processing:  2
Processing:  4
End:   The input is:

Weitere Informationen finden Sie unter Verwenden von Enumeratoren.

Filter

Ein Filter ist ein Funktionstyp, der für jedes Objekt in der Pipeline ausgeführt wird. Ein Filter ähnelt einer Funktion mit allen zugehörigen Anweisungen in einem Process Block.

Die Syntax eines Filters lautet wie folgt:

filter [<scope:>]<name> {<statement list>}

Der folgende Filter übernimmt Protokolleinträge aus der Pipeline und zeigt dann entweder den gesamten Eintrag oder nur den Nachrichtenteil des Eintrags an:

filter Get-ErrorLog ([switch]$message)
{
  if ($message) { Out-Host -InputObject $_.Message }
  else { $_ }
}

Funktionsbereich

Eine Funktion ist in dem Bereich vorhanden, in dem sie erstellt wurde.

Wenn eine Funktion Teil eines Skripts ist, ist die Funktion für Anweisungen in diesem Skript verfügbar. Standardmäßig ist eine Funktion in einem Skript an der Eingabeaufforderung nicht verfügbar.

Sie können den Bereich einer Funktion angeben. Die Funktion wird beispielsweise im folgenden Beispiel dem globalen Bereich hinzugefügt:

function global:Get-DependentSvs {
  Get-Service | Where-Object {$_.DependentServices}
}

Wenn sich eine Funktion im globalen Bereich befindet, können Sie die Funktion in Skripts, in Funktionen und an der Befehlszeile verwenden.

Funktionen erstellen normalerweise einen Bereich. Die in einer Funktion erstellten Elemente, z. B. Variablen, sind nur im Funktionsbereich vorhanden.

Weitere Informationen zum Bereich in PowerShell finden Sie unter about_Scopes.

Suchen und Verwalten von Funktionen mithilfe der Funktion: Laufwerk

Alle Funktionen und Filter in PowerShell werden automatisch auf dem Function: Laufwerk gespeichert. Dieses Laufwerk wird vom PowerShell-Funktionsanbieter verfügbar gemacht.

Wenn Sie auf das Function: Laufwerk verweisen, geben Sie einen Doppelpunkt nach Der Funktion ein, wie Sie es beim Verweisen auf das C Laufwerk oder D eines Computers tun würden.

Der folgende Befehl zeigt alle Funktionen in der aktuellen PowerShell-Sitzung an:

Get-ChildItem function:

Die Befehle in der Funktion werden als Skriptblock in der Definitionseigenschaft der Funktion gespeichert. Geben Sie beispielsweise Folgendes ein, um die Befehle in der Mit PowerShell enthaltenen Hilfefunktion anzuzeigen:

(Get-ChildItem function:help).Definition

Sie können auch die folgende Syntax verwenden.

$function:help

Weitere Informationen zum Function: Laufwerk finden Sie im Hilfethema für den Funktionsanbieter . Geben Sie Get-Help Functionein.

Wiederverwenden von Funktionen in neuen Sitzungen

Wenn Sie an der PowerShell-Eingabeaufforderung eine Funktion eingeben, wird die Funktion Teil der aktuellen Sitzung. Es ist verfügbar, bis die Sitzung endet.

Um Ihre Funktion in allen PowerShell-Sitzungen zu verwenden, fügen Sie die Funktion Ihrem PowerShell-Profil hinzu. Weitere Informationen zu Profilen finden Sie unter about_Profiles.

Sie können Ihre Funktion auch in einer PowerShell-Skriptdatei speichern. Geben Sie Ihre Funktion in eine Textdatei ein, und speichern Sie die Datei dann mit der .ps1 Dateinamenerweiterung.

Schreiben von Hilfe für Funktionen

Das Get-Help Cmdlet erhält Hilfe für Funktionen sowie für Cmdlets, Anbieter und Skripts. Geben Sie den Namen der Funktion ein, Get-Help um Hilfe für eine Funktion zu erhalten.

Geben Sie beispielsweise Folgendes ein, um Hilfe für die Get-MyDisks Funktion zu erhalten:

Get-Help Get-MyDisks

Sie können Hilfe für eine Funktion schreiben, indem Sie eine der beiden folgenden Methoden verwenden:

Comment-Based Hilfe für Funktionen

Create ein Hilfethema mithilfe spezieller Schlüsselwörter in den Kommentaren. Um kommentarbasierte Hilfe für eine Funktion zu erstellen, müssen die Kommentare am Anfang oder Ende des Funktionstexts oder in den Zeilen vor der Funktion Schlüsselwort (keyword) platziert werden. Weitere Informationen zur kommentarbasierten Hilfe finden Sie unter about_Comment_Based_Help.
XML-Based Hilfe für Funktionen

Create ein XML-basiertes Hilfethema, z. B. den Typ, der normalerweise für Cmdlets erstellt wird. Xml-basierte Hilfe ist erforderlich, wenn Sie Hilfethemen in mehrere Sprachen lokalisieren.

Um die Funktion dem XML-basierten Hilfethema zuzuordnen, verwenden Sie die .ExternalHelp kommentarbasierte Hilfe Schlüsselwort (keyword). Ohne diesen Schlüsselwort (keyword), kann das Funktionshilfethema nicht gefunden werden, Get-Help und Aufrufe Get-Help von für die Funktion geben nur automatisch generierte Hilfe zurück.

Weitere Informationen zum ExternalHelp Schlüsselwort (keyword) finden Sie unter about_Comment_Based_Help. Weitere Informationen zur XML-basierten Hilfe finden Sie in der Hilfe zum Schreiben von Cmdlets.