SPWindowsService members
Represents a Windows service that is installed on one or more servers in the server farm.
The SPWindowsService type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SPWindowsService() | The default constructor, which is called implicitly by the default constructors of derived classes. |
.gif "Protected method") |
SPWindowsService(String, SPFarm) | Initializes a new instance of the SPWindowsService class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Applications | Gets the collection of service applications associated with the service. (Inherited from SPService.) |
|
AutoProvision | Available in SharePoint 2016 and later. Gets (and in some scenarios sets) a Boolean value that indicates whether the service is enabled on the farm. (Inherited from SPService.) |
|
CanUpgrade | Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.) |
|
CompliantWithMinRole | (Inherited from SPService.) |
|
DeploymentLocked | (Inherited from SPPersistedObject.) |
|
Description | (Inherited from SPService.) |
|
DisplayName | Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.) |
|
Farm | Gets the server farm where the object resides. (Inherited from SPPersistedObject.) |
|
Hidden | (Inherited from SPService.) |
|
Id | Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.) |
|
Instances | Gets a collection of all instances of the service in the server farm. (Inherited from SPService.) |
|
IsBackwardsCompatible | Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.) |
|
JobDefinitions | Gets a collection of job definitions for this service. (Inherited from SPService.) |
|
JobHistoryEntries | Gets an enumeration of the job history entries for this service. (Inherited from SPService.) |
|
Name | Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.) |
|
NeedsUpgrade | Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.) |
|
NeedsUpgradeIncludeChildren | Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.) |
|
Parent | Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.) |
|
ProcessIdentity | Gets the process identity for the Windows service. |
|
Properties | Gets metadata for the persisted object. (Inherited from SPPersistedObject.) |
|
Required | Gets a Boolean value that indicates whether an instance of the service must be running on at least one computer in the server farm. (Inherited from SPService.) |
|
RunningJobs | Gets a collection of running jobs for this service. (Inherited from SPService.) |
|
ShouldDeferUpgradeActions | (Inherited from SPPersistedUpgradableObject.) |
|
Status | Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.) |
|
SystemService | (Inherited from SPService.) |
|
TypeName | Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.) |
|
UpgradeContext | Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.) |
|
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) |
|
Version | Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.) |
.gif "Protected property") |
WasCreated | Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Clone | Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.) |
|
Delete | Removes the service and associated resources. (Inherited from SPService.) |
|
Equals | Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.) |
|
Finalize | (Inherited from Object.) |
|
GetChild<T>() | Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.) |
|
GetChild<T>(String) | Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.) |
|
GetCreateApplicationLink | Gets the administration user interface link that is used to create a new service application. (Inherited from SPService.) |
|
GetCreateApplicationOptions | Gets the options for creating a new service application. (Inherited from SPService.) |
|
GetFirstPreconfiguredDatabase | (Inherited from SPService.) |
|
GetHashCode | Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.) |
|
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) |
|
GetPreconfiguredDatabaseInfo | (Inherited from SPService.) |
|
GetType | (Inherited from Object.) |
|
HasAdditionalUpdateAccess | Override this method to allow more users to update the object. (Inherited from SPPersistedObject.) |
|
Invalidate | Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.) |
|
IsUserLicensedForEntity | Checks if the current user has the proper license to access the specified entity. (Inherited from SPService.) |
|
LegacyUpdate | (Inherited from SPPersistedObject.) |
|
MemberwiseClone | (Inherited from Object.) |
|
OnDeserialization | Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.) |
|
OnPasswordChange | Override this if you need special processing for password change events. |
|
OnPostCreate | (Inherited from SPPersistedObject.) |
|
OnPreCreate | (Inherited from SPPersistedObject.) |
|
Provision | Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.) |
|
RunWithConcurrencyRetries | (Inherited from SPPersistedObject.) |
|
ToString | Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.) |
|
Uncache | Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.) |
|
Unprovision | Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.) |
|
Update() | Causes the service to update its state and propagate the changes throughout the farm. (Overrides SPPersistedObject.Update().) |
|
Update(Boolean) | Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.) |
|
UpdateCredentials | Updates the credentials for the Windows service when its username or password changes. |
|
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) |
|
UpdateWithNoObjectCallbackCheck | (Inherited from SPPersistedObject.) |
|
Upgrade() | Upgrades the object. (Inherited from SPPersistedUpgradableObject.) |
|
Upgrade(Boolean) | Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.) |
|
Validate | Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.) |
|
ValidateBackwardsCompatibility | Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.) |
Top