Share via


Index.MarkForDrop Method

Marks the index to be dropped the next time that the Alter method is run on the Index object's parent object.

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

Syntax

'Declaration
Public Sub MarkForDrop ( _
    dropOnAlter As Boolean _
)
'Usage
Dim instance As Index
Dim dropOnAlter As Boolean

instance.MarkForDrop(dropOnAlter)
public void MarkForDrop(
    bool dropOnAlter
)
public:
virtual void MarkForDrop(
    bool dropOnAlter
) sealed
abstract MarkForDrop : 
        dropOnAlter:bool -> unit 
override MarkForDrop : 
        dropOnAlter:bool -> unit 
public final function MarkForDrop(
    dropOnAlter : boolean
)

Parameters

  • dropOnAlter
    Type: System.Boolean
    A Boolean value that specifies whether to drop the index the next time the parent object is altered.
    If True, the index is dropped when the parent is altered. Otherwise, False.

Implements

IMarkForDrop.MarkForDrop(Boolean)

Remarks

Note

Indexes based on the UserDefinedTableType object cannot be modified and running this method will generate an exception.