Share via

ScriptingOptions.LoginSid Property

  • Article

Gets or sets the Boolean property value that specifies whether the security identifiers are included for any scripted logins in the generated script.

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

Syntax

'Declaration
Public Property LoginSid As Boolean 
    Get 
    Set
'Usage
Dim instance As ScriptingOptions 
Dim value As Boolean 

value = instance.LoginSid

instance.LoginSid = value

public bool LoginSid { get; set; }

public:
property bool LoginSid {
    bool get ();
    void set (bool value);
}

member LoginSid : bool with get, set

function get LoginSid () : boolean 
function set LoginSid (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether the security identifiers are included for any scripted logins in the generated script.If True, the security identifiers are included for any scripted logins in the generated script. Otherwise, False (default).

Examples

The following code example specifies that security identifiers for scripted logins will be added to the script.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.LoginSid = true

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.LoginSid = $TRUE

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting