Compartir a través de

Miembros SPCmdlet

  • Artículo

Representa una clase base abstracta para todos los cmdlets personalizados que se escriben para usarse en las implementaciones de SharePoint, proporcionar un comportamiento uniforme en todos los cmdlets de SharePoint.

El tipo SPCmdlet expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público SPCmdlet Cuando se reemplaza en la clase derivada, este constructor inicializa una nueva instancia de la clase derivada.

Arriba

Propiedades

  Nombre Descripción
Propiedad pública AssignmentCollection Obtiene o establece el objeto SPAssignmentCollection que se pasa a través de las canalizaciones de cmdlet para su uso por el comando final.
Propiedad pública CommandOrigin (Heredado desde InternalCommand).
Propiedad pública CommandRuntime (Heredado desde Cmdlet).
Propiedad protegida ConfirmationMessage Obtiene o establece un mensaje que se usa para solicitar confirmación al usuario.
Propiedad pública CurrentPSTransaction (Heredado desde Cmdlet).
Propiedad protegida DisposeOutputObjects Obtiene o establece un valor booleano que especifica si la clase base eliminar objetos de salida después de que han sido va a producir.
Propiedad pública Events (Heredado desde PSCmdlet).
Propiedad protegida Fields Un contenedor de propiedades que contiene las propiedades públicas del cmdlet.
Propiedad pública Host (Heredado desde PSCmdlet).
Propiedad pública InvokeCommand (Heredado desde PSCmdlet).
Propiedad pública InvokeProvider (Heredado desde PSCmdlet).
Propiedad pública JobRepository (Heredado desde PSCmdlet).
Propiedad pública MyInvocation (Heredado desde PSCmdlet).
Propiedad pública ParameterSetName (Heredado desde PSCmdlet).
Propiedad pública SessionState (Heredado desde PSCmdlet).
Propiedad pública Stopping (Heredado desde Cmdlet).

Arriba

Métodos

  Nombre Descripción
Método protegido BeginProcessing Inicio de conjuntos de marcadores para la ejecución del cmdlet, durante qué pasos de procesamiento como se realizan las comprobaciones de permiso y el registro; Este método se llama una vez al principio de la ejecución de cmd. (Reemplaza a CmdletBeginProcessing()).
Método público CurrentProviderLocation (Heredado desde PSCmdlet).
Método protegido EndProcessing Proporciona un medio para agregar la funcionalidad de posprocesamiento para el cmdlet. (Reemplaza a CmdletEndProcessing()).
Método público Equals (Heredado desde Object).
Método protegido Finalize (Heredado desde Object).
Método público GetHashCode (Heredado desde Object).
Método protegido GetProp<T> Recupera el objeto de la propiedad Fields que está asociada con el nombre del campo especificado.
Método protegido GetPropV<S> Recupera la estructura de la propiedad Fields que está asociada con el nombre de campo especificado.
Método público GetResolvedProviderPathFromPSPath (Heredado desde PSCmdlet).
Método público GetResourceString (Heredado desde Cmdlet).
Método protegido GetSwitch Recupera un objeto SwitchParameter , si se encuentra uno.
Método público GetType (Heredado desde Object).
Método público GetUnresolvedProviderPathFromPSPath (Heredado desde PSCmdlet).
Método público GetVariableValue(String) (Heredado desde PSCmdlet).
Método público GetVariableValue(String, Object) (Heredado desde PSCmdlet).
Método protegido InternalBeginProcessing Este método se ejecuta en el método BeginProcessing() y antes de parámetros de canalización en que se establecen (método) y, por tanto, proporciona un medio para que los usuarios agregar funcionalidad del programa para el método BeginProcessing() .
Método protegido InternalDispose Usar las clases heredadas para proporcionar código de limpieza para eliminar objetos que se crearon mediante los métodos InternalValidate(), ConfirmationMessageo InternalProcessRecord() .
Método protegido InternalEndProcessing Este método se ejecuta en el método EndProcessing() y por lo tanto, proporciona un medio para que los usuarios agregar funcionalidad del programa para el método EndProcessing() al final de la ejecución del cmdlet.
Método protegido InternalProcessRecord Proporciona un medio para que los usuarios agregar la funcionalidad del programa para la función ProcessRecord() .
Método protegido InternalStopProcessing Proporciona un medio para que los usuarios agregar la funcionalidad del programa para la función StopProcessing() .
Método protegido InternalValidate Proporciona un medio para validar la entrada del usuario durante la ejecución del método ProcessRecord() .
Método público Invoke (Heredado desde Cmdlet).
Método protegido MemberwiseClone (Heredado desde Object).
Método protegido ProcessRecord Proporciona la funcionalidad de procesamiento registro por registro para el cmdlet y registra las entradas de la ejecución de cada registro. Este método se llama una vez para cada objeto canalizada (es decir, para todos los registros). (Reemplaza a CmdletProcessRecord()).
Método protegido RequireLocalFarmExist Obtiene o establece un valor booleano que especifica si debe existir un conjunto de servidores local para que pueda ejecutar el cmdlet.
Método protegido RequireUserFarmAdmin Especifica si un cmdlet tiene privilegios de administrador de granja de servidores para poder ejecutarse.
Método protegido RequireUserMachineAdmin Especifica si un cmdlet tiene privilegios de administrador en el equipo en el que se ejecuta.
Método protegido SetProp Sólo para uso interno. No use.
Método público ShouldContinue(String, String) (Heredado desde Cmdlet).
Método público ShouldContinue(String, String, Boolean, Boolean) (Heredado desde Cmdlet).
Método público ShouldProcess(String) (Heredado desde Cmdlet).
Método público ShouldProcess(String, String) (Heredado desde Cmdlet).
Método público ShouldProcess(String, String, String) (Heredado desde Cmdlet).
Método público ShouldProcess(String, String, String, ShouldProcessReason) (Heredado desde Cmdlet).
Método protegido SkipProcessCurrentRecord Proporciona un medio para detener el procesamiento de un registro determinado y para omitir ese registro al siguiente.
Método protegido StopProcessing Detiene registre procesamiento en casos donde el usuario detiene el cmdlet de forma asincrónica. PowerShell llama a este método cuando el usuario consigue las teclas Ctrl-C. (Reemplaza a CmdletStopProcessing()).
Método público ThrowTerminatingError(ErrorRecord) (Heredado desde Cmdlet).
Método protegido ThrowTerminatingError(Exception, ErrorCategory, Object) Escribe los detalles de un error de finalización en la pantalla como un mensaje de error y los detalles de los registros en un archivo de registro.
Método protegido ThrowTerminatingError(Exception, ErrorCategory, Object, String) Escribe los detalles de un error de finalización en la pantalla como un mensaje de error y los detalles de los registros en un archivo de registro.
Método público ToString (Heredado desde Object).
Método público TransactionAvailable (Heredado desde Cmdlet).
Método público WriteCommandDetail (Heredado desde Cmdlet).
Método público WriteDebug (Heredado desde Cmdlet).
Método público WriteError(ErrorRecord) (Heredado desde Cmdlet).
Método protegido WriteError(Exception, ErrorCategory, Object) Escribe los detalles de errores de no terminación en la pantalla como un mensaje de error y los detalles de los registros en un archivo de registro.
Método protegido WriteError(Exception, ErrorCategory, Object, String) Escribe los detalles de errores de no terminación en la pantalla como un mensaje de error y los detalles de los registros en un archivo de registro.
Método público WriteObject(Object) (Heredado desde Cmdlet).
Método público WriteObject(Object, Boolean) (Heredado desde Cmdlet).
Método público WriteProgress(ProgressRecord) (Heredado desde Cmdlet).
Método protegido WriteProgress(String, String) Escribe la información de progreso en la pantalla en relación con el cmdlet ejecutando.
Método protegido WriteProgress(String, String, Int32) Escribe la información de progreso en la pantalla en relación con el cmdlet ejecutando.
Método protegido WriteResult Muestra una instancia de objeto y los escribe en la pantalla de la consola o a la canalización de cmdlet.
Método público WriteVerbose (Heredado desde Cmdlet).
Método público WriteWarning(String) (Heredado desde Cmdlet).
Método protegido WriteWarning(String, String) Proporciona un medio para mostrar un mensaje de advertencia al usuario.

Arriba

Vea también

Referencia

clase SPCmdlet

Espacio de nombres Microsoft.SharePoint.PowerShell