ARGOMENTO
about_Functions_CmdletBindingAttribute
DESCRIZIONE BREVE
Descrive un attributo che dichiara una funzione con comportamento
analogo a un cmdlet compilato.
DESCRIZIONE DETTAGLIATA
Quando si scrivono funzioni, è possibile aggiungere l'attributo
CmdletBinding in modo che i parametri della funzione vengano
associati nello stesso modo in cui vengono associati i parametri
dei cmdlet compilati. Quando viene dichiarato questo attributo,
viene inoltre impostata la variabile automatica $PSCmdlet.
Quando si l'associazione cmdlet, i parametri sconosciuti e gli
argomenti posizionali che non dispongono di parametri posizionali
corrispondenti causano l'esito negativo dell'associazione dei
parametri. Inoltre, una funzione o uno script con associazione
cmdlet non utilizza la variabile $args.
Nota: i cmdlet compilati utilizzano l'attributo Cmdlet
obbligatorio analogo all'attributo CmdletBinding
descritto in questo argomento.
Nell'esempio seguente viene mostrata la struttura di una funzione che
specifica tutti gli argomenti facoltativi dell'attributo
CmdletBinding. Segue l'esempio una breve descrizione di ogni argomento
{
[CmdletBinding(SupportsShouldProcess=<Boolean>,
ConfirmImpact=<Stringa>,
DefaultParameterSetName=<Stringa>)]
Param ($Parameter1)
Begin{}
Process{}
End{}
}
SupportsShouldProcess
Quando l'argomento SupportsShouldProcess viene impostato su
true, indica che la funzione supporta chiamate al metodo
ShouldProcess, utilizzato per richiedere all'utente feedback
prima che la funzione apporti una modifica al sistema. Quando viene
specificato questo argomento, i parametri Confirm e WhatIf sono
abilitati per la funzione.
Per ulteriori informazioni sulle richieste di conferma, vedere
l'argomento relativo in MSDN Library all'indirizzo
https://go.microsoft.com/fwlink/?LinkId=136658 (le informazioni
potrebbero essere in lingua inglese).
DefaultParameterSetName
L'argomento DefaultParameterSetName specifica il nome del set
di parametri che si tenterà di utilizzare quando non è possibile
determinare quale set di parametri utilizzare. È possibile evitare questo
problemi rendendo obbligatorio il parametro univoco di ogni set di
parametro.
ConfirmImpact
L'argomento ConfirmImpact specifica quando l'azione della
funzione deve essere confermata da una chiamata al metodo
ShouldProcess. La chiamata al metodo ShouldProcess visualizza
un prompt di conferma solo quando l'argomento ConfirmImpact è
uguale o maggiore del valore della variabile di preferenza
$ConfirmPreference (il valore predefinito dell'argomento è Medium).
Specificare questo argomento solo quando viene specificato anche
l'argomento SupportsShouldProcess.
VEDERE ANCHE
about_Functions_Advanced
about_Functions_CmdletBindingAttribute
about_Functions_ParameterAttributes