AffinityInfo.Alter Method

  • Article

This method updates the server with the current values in the AffinityInfo class.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Sub Alter
'Usage
Dim instance As AffinityInfo

instance.Alter()

public void Alter()

public:
virtual void Alter() sealed

abstract Alter : unit -> unit  
override Alter : unit -> unit

public final function Alter()

Implements

IAlterable.Alter()

Remarks

To set any AffinityInfo object properties and run the Alter method, users must have ALTER permission on the database.

Examples

This example shows you how to set an Instance of SQL Server to Auto affinity.

C#

using System;
using Microsoft.SqlServer.Management.Smo;

namespace samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Server dbServer = new Server("(local)");
            dbServer.AffinityInfo.Refresh();
            dbServer.AffinityInfo.AffinityType = AffinityType.Auto;
            dbServer.AffinityInfo.Alter();
        }
    }
}

Powershell

//Create the server. 
$dbServer = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")

//Set the Affinity Type to Auto
#dbServer.AffinityInfo.Refresh()
$dbServer.AffinityInfo.AffinityType = [Microsoft.SqlServer.Management.Smo.AffinityType]'Auto'
$dbServer.AffinityInfo.Alter()

See Also

Reference

AffinityInfo Class

Microsoft.SqlServer.Management.Smo Namespace