ScriptingOptions.Remove Method

Removes a ScriptOption object from the ScriptingOptions object.

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

Syntax

'Declaration
Public Function Remove ( _
    scriptOption As ScriptOption _
) As ScriptingOptions
'Usage
Dim instance As ScriptingOptions 
Dim scriptOption As ScriptOption 
Dim returnValue As ScriptingOptions 

returnValue = instance.Remove(scriptOption)

public ScriptingOptions Remove(
    ScriptOption scriptOption
)

public:
ScriptingOptions^ Remove(
    ScriptOption^ scriptOption
)

member Remove : 
        scriptOption:ScriptOption -> ScriptingOptions

public function Remove(
    scriptOption : ScriptOption
) : ScriptingOptions

Parameters

• scriptOption
  Type: Microsoft.SqlServer.Management.Smo.ScriptOption
  A ScriptOption object to be removed from the ScriptingOptions object.

Return Value

Type: Microsoft.SqlServer.Management.Smo.ScriptingOptions
A ScriptingOptions object that does not contain the removed ScriptOption object.

Examples

The following code example removes a script option.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.WithDependencies = true
scOps.Remove(ScriptOption.WithDependencies)

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.WithDependencies = $TRUE
$scOps.Remove([Microsoft.SqlServer.Management.Smo.ScriptOption]::WithDependencies)

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting