SPUserCodeService Members

Include Protected Members
Include Inherited Members

Manages the settings and features for the service that executes sandboxed solutions.

The SPUserCodeService type exposes the following members.

Constructors

	Name	Description
	SPUserCodeService()	Initializes a new instance of the SPUserCodeService class.
	SPUserCodeService(SPFarm)	Initializes a new instance of the SPUserCodeService class based in the specified Microsoft SharePoint Foundation farm.

Top

Properties

	Name	Description
	AlwaysRecycleAppDomains	Gets or sets a value that indicates whether the service should keep the application domain of a specific sandboxed solution alive after the solution has finished and reuse the same domain the next time there is are request for the same solution.
	Applications	Gets the collection of service applications associated with the service. (Inherited from SPService.)
	AspNetRootFolder	Gets or sets the full path of the root folder for sandboxed solution service requests that originate outside ASP.NET.
	BlockedSolutions	Gets the collection of sandboxed solutions that are blocked in the Microsoft SharePoint Foundation farm.
	CanBackupRestoreAsConfiguration	Gets a value that indicates whether the service object can be included in a configuration-only backup or restore operation.
	CanRenameOnRestore	Gets a value that indicates whether the SPUserCodeService can be renamed when it is restored.
	CanSelectForBackup	Gets or sets a value that indicates whether the SPUserCodeService can be selected individually for a backup operation.
	CanSelectForRestore	Gets or sets a value that indicates whether the SPUserCodeService can be selected individually for a restore operation.
	CanUpgrade	Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
	DataAggregationInterval	Gets or sets the amount of time, in seconds, between the data aggregation service operations that push data back into the content database.
	DiskSizeRequired	Gets the disk space that is required for a backup.
	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.)
	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.)
	IsEnabled	Gets a value that indicates whether the current service is provisioned and running as expected.
	JobDefinitions	Gets a collection of job definitions for this service. (Inherited from SPService.)
	JobHistoryEntries	(Inherited from SPService.)
	LoadBalancer	Gets or sets the load balancer that assigns requests for sandboxed solutions to particular servers when the farm is running sandboxed solutions in affinity mode (sometimes called “remote mode”).
	Local	Gets the main user code service that is associated with this farm.
	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. (Inherited from SPWindowsService.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	ProxyOperationTypes	Gets the collection of proxy operation types that are registered in the Microsoft SharePoint Foundation farm.
	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.)
	ResourceMeasures	Gets the collection of measures for regulating the resource usage of services in the Microsoft SharePoint Foundation farm.
	ResourceUsageRetentionDays	Gets or sets the number of days to retain resource usage information in the content database.
	RunningJobs	Gets a collection of running jobs for this service. (Inherited from SPService.)
	SecurityPolicyFileCore	Gets or sets the name of the security policy configuration file for requests that originate outside ASP.NET.
	ServicePort	Gets or sets the port number used to connect to the service.
	SolutionValidators	Gets the collection of solution validators for validating sandboxed solutions.
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	Tiers	Gets the collection of properties that describes the execution tiers.
	TypeName	Gets the friendly name used to describe the instance of the service that runs sandboxed solutions. (Overrides SPPersistedObject.TypeName.)
	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.)
	UseLocalServerOnly	Gets or sets a value that indicates whether the service must use only the local machine.
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
	WorkerProcessExecutionTimeout	Gets or sets the amount of time, in seconds, that a single request is allowed to execute inside the sandboxed worker process.
	WorkerProcessRecycleTime	Gets or sets the amount of time, in minutes, that sandboxed worker processes are automatically recycled.

Top

Methods

	Name	Description
	AddBackupObjects	Adds the SPUserCodeService and any child objects that implement the IBackupRestore interface to the backup or restore operation.
	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	(Inherited from SPService.)
	GetCreateApplicationOptions	(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.)
	GetSolutionSignatureFromFile	Gets the signature of a specified sandboxed solution package.
	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.)
	MemberwiseClone	(Inherited from Object.)
	OnAbort	Raises the Abort event.
	OnBackup	Raises the Backup event.
	OnBackupComplete	Raises the BackupComplete event.
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	OnPasswordChange	(Inherited from SPWindowsService.)
	OnPostRestore	Raises the PostRestore event.
	OnPrepareBackup	Raises the PrepareBackup event.
	OnPreRestore	Raises the PreRestore event.
	OnRestore	Raises the Restore event.
	Provision	Makes the changes to the local server that are needed before the object can be used. (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()	Saves the state of the service and propagates the changes to all the servers in the server farm. (Overrides SPWindowsService.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. (Inherited from SPWindowsService.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	UpdateRegistryKeyPermissions	Updates the permissions for the built-in user account to access the registry key.
	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

See Also

Reference

SPUserCodeService Class

Microsoft.SharePoint.Administration Namespace