SPPersistedObject.Update Method (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.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)> _
Public Overridable Sub Update ( _
    ensure As Boolean _
)
'Usage
Dim instance As SPPersistedObject
Dim ensure As Boolean

instance.Update(ensure)
[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)]
public virtual void Update(
    bool ensure
)

Parameters

  • ensure
    Type: System.Boolean

    true to silently reinitialize the object with an existing object's data if the object already exists in the configuration store; false to throw an exception if the object already exists.

Remarks

Important

Do not call this method on the SPFarm object. If you have farm-wide settings that need to be persisted, derive a class from SPPersistedObject specifically to hold those settings.

See Also

Reference

SPPersistedObject Class

SPPersistedObject Members

Update Overload

Microsoft.SharePoint.Administration Namespace