• Article

ConnectionSettings.SecureConnectionString Property

Gets or sets an encrypted version of the connection string.

Namespace:  Microsoft.SqlServer.Management.Common
Assembly:  Microsoft.SqlServer.ConnectionInfo (in Microsoft.SqlServer.ConnectionInfo.dll)

Syntax

'Declaration
<BrowsableAttribute(False)> _
Public Property SecureConnectionString As SecureString
    Get
    Set
'Usage
Dim instance As ConnectionSettings
Dim value As SecureString

value = instance.SecureConnectionString

instance.SecureConnectionString = value

[BrowsableAttribute(false)]
public SecureString SecureConnectionString { get; set; }

[BrowsableAttribute(false)]
public:
property SecureString^ SecureConnectionString {
    SecureString^ get ();
    void set (SecureString^ value);
}

[<BrowsableAttribute(false)>]
member SecureConnectionString : SecureString with get, set

function get SecureConnectionString () : SecureString
function set SecureConnectionString (value : SecureString)

Property Value

Type: System.Security.SecureString
A SecureString value that specifies an encrypted connection string.

Remarks

If this property is explicitly set, all properties in the ServerConnection object will be populated to reflect the values in the supplied connection string.

If you attempt to set this property when the connection cannot be changed, a ConnectionCannotBeChangedException exception is thrown.