Share via


SPFarmAction members

Abstract super class for all SPFarm upgrade actions.

The SPFarmAction type exposes the following members.

Constructors

  Name Description
Protected method SPFarmAction

Top

Properties

  Name Description
Public property Description Gets a string that contains a description for the action. (Inherited from SPAction.)
Public property Farm
Protected property FromBuildVersion Gets the version number of the build that is being upgraded. (Inherited from SPAction.)
Protected property HonorTargetSchemaVersion Obsolete. Property to indicate if schema version should be honored for actions with FromBuild/ToBuild. (Inherited from SPAction.)
Public property Log Gets an SPLog object. The SPAction class should use this SPLog object to log any errors, warnings or debug information during the upgrade process. (Inherited from SPAction.)
Protected property Manager Gets the Microsoft SharePoint Foundation upgrade manager object. (Inherited from SPAction.)
Public property ShouldRun Gets a Boolean value that indicates whether the upgrade action should run. (Inherited from SPAction.)
Protected property SPSequence Gets the sequence object that represents the upgrade sequence. (Inherited from SPAction.)
Protected property TargetSchemaVersion Gets the schema version to which the Microsoft SharePoint Foundation installation is being upgraded. (Inherited from SPAction.)
Protected property ToBuildVersion Gets the version number of the build to which the Microsoft SharePoint Foundation installation is being upgraded. (Inherited from SPAction.)
Protected property Type Gets the type of object that is being upgraded through the action. (Inherited from SPAction.)
Protected property UpgradableObject Gets an object representing the object that is being upgraded by this SPAction class, as well as other SPAction objects contained in the SPSequence object. (Inherited from SPAction.)

Top

Methods

  Name Description
Public method Commit Default implementation is a noop. (Overrides SPAction.Commit().)
Public method Dispose Releases all unmanaged resources used by the upgrade action. (Inherited from SPAction.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Initialize Initializes the upgrade action based on the specified object and sequence. (Inherited from SPAction.)
Protected method MemberwiseClone (Inherited from Object.)
Protected methodStatic member RemoveSolution
Public method Rollback Default implementation is a noop. (Overrides SPAction.Rollback().)
Public method ToString (Inherited from Object.)
Public method Upgrade Executes the upgrade logic for the action. (Inherited from SPAction.)

Top

See also

Reference

SPFarmAction class

Microsoft.SharePoint.Upgrade namespace