TEMA

about_Functions_CmdletBindingAttribute
DESCRIPCIN BREVE
Describe un atributo que declara una funcin que funciona de
manera parecida a un cmdlet compilado.
DESCRIPCIN DETALLADA
Al escribir funciones, se puede agregar el atributo CmdletBinding
para que Windows PowerShell enlace los parmetros de la funcin
del mismo modo que enlaza los parmetros de los cmdlets
compilados. Cuando se declara este atributo, Windows PowerShell
tambin establece la variable automtica $PSCmdlet.
Cuando se utiliza el enlace de cmdlets, los parmetros
desconocidos y los argumentos posicionales que no tienen parmetros
posicionales equivalentes producen un error en el enlace. Adems, una
funcin o script con enlace de cmdlets no utiliza la variable $args.
Nota: los cmdlets compilados utilizan el atributo Cmdlet
obligatorio, que es parecido al atributo CmdletBinding que se
describe en este tema.
En el ejemplo siguiente se muestra el esquema de una funcin que
especifica todos los argumentos opcionales del atributo CmdletBinding.
Despus del ejemplo se proporciona una descripcin breve de cada
argumento.
{
[CmdletBinding(SupportsShouldProcess=<Boolean>,
ConfirmImpact=<String>,
DefaultParameterSetName=<String>)]
Param ($Parameter1)
Begin{}
Process{}
End{}
}
SupportsShouldProcess
Cuando el argumento SupportsShouldProcess se establece en true,
indica que la funcin admite las llamadas al mtodo
ShouldProcess, que se utiliza para solicitar datos al usuario
antes de que la funcin realice un cambio en el sistema. Cuando se
especifica este argumento, los parmetros Confirm y WhatIf se
habilitan para la funcin.
Para obtener ms informacin sobre las solicitudes de
confirmacin, vea "Requesting Confirmation" en MSDN Library, en
http://go.microsoft.com/fwlink/?LinkId=136658.
DefaultParameterSetName
El argumento DefaultParameterSetName especifica el nombre del

conjunto de parmetros que Windows PowerShell intentar

utilizar cuando no puede determinar qu conjunto de parmetros debe
utilizar. Se puede evitar este problema haciendo obligatorio el
parmetro nico de cada conjunto de parmetros.
ConfirmImpact
El argumento ConfirmImpact especifica cundo la accin de la
funcin se debe confirmar mediante una llamada al mtodo
ShouldProcess. La llamada al mtodo ShouldProcess muestra un
mensaje de confirmacin solamente cuando el argumento
ConfirmImpact es mayor o igual que el valor de la variable de
preferencias $ConfirmPreference. (El valor predeterminado del
argumento es Medium.) Este argumento nicamente debe
especificarse si se especifica tambin el argumento
SupportsShouldProcess.
VEA TAMBIN
about_Functions_Advanced
about_Functions_CmdletBindingAttribute
about_Functions_ParameterAttributes