Eigenschappen declareren als parameters

Dit onderwerp bevat basisinformatie die u moet begrijpen voordat u de parameters van een cmdlet declareer.

Als u de parameters van een cmdlet in uw cmdlet-klasse wilt declaren, definieert u de openbare eigenschappen die elke parameter vertegenwoordigen en voegt u vervolgens een of meer Parameterkenmerken toe aan elke eigenschap. De Windows PowerShell runtime gebruikt de parameterkenmerken om de eigenschap te identificeren als een cmdlet-parameter. De basissyntaxis voor het declareren van het kenmerk Parameter is [Parameter()] .

Hier is een voorbeeld van een eigenschap die is gedefinieerd als een vereiste parameter.

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

Hier zijn enkele dingen die u moet onthouden over parameters.

• Een parameter moet expliciet worden gemarkeerd als openbaar. Parameters die niet als openbare standaardwaarde voor intern zijn gemarkeerd en niet worden gevonden door de Windows PowerShell runtime.

• Parameters moeten worden gedefinieerd als Microsoft-.NET Framework voor betere parametervalidatie. Parameters die zijn beperkt tot één waarde uit een set waarden moeten bijvoorbeeld worden gedefinieerd als een type enumeratie. Parameters die een URI-waarde (Uniform Resource Identifier) hebben, moeten van het type System.Uri zijn.

• Vermijd eenvoudige tekenreeksparameters voor alle teksteigenschappen, behalve vrije tekst.

• U kunt een parameter toevoegen aan een groot aantal parametersets. Zie Cmdlet Parameter Sets (Cmdlet-parametersets) voor meer informatie over parametersets.

Windows PowerShell biedt ook een set algemene parameters die automatisch beschikbaar zijn voor elke cmdlet. Zie Cmdlet Common Parameters voor meer informatie over deze parameters en hun aliassen.

Zie ook

Algemene parameters voor cmdlet

Typen cmdlet-parameters

Een Windows PowerShell-cmdlet schrijven