• Article

SnapshotGenerationAgent.SecureDistributorPassword Property

Sets the password (as a SecureString object) used when connecting locally to the Distributor using SQL Server Authentication.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)

Syntax

'Declaration
<ComVisibleAttribute(False)> _
Public Property SecureDistributorPassword As SecureString
    Get
    Set
'Usage
Dim instance As SnapshotGenerationAgent
Dim value As SecureString

value = instance.SecureDistributorPassword

instance.SecureDistributorPassword = value

[ComVisibleAttribute(false)]
public SecureString SecureDistributorPassword { get; set; }

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

[<ComVisibleAttribute(false)>]
member SecureDistributorPassword : SecureString with get, set

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

Property Value

Type: System.Security.SecureString

Remarks

The SecureDistributorPassword property provides additional security for the password while it is stored in memory and should be used instead of DistributorPassword.

When possible, use Windows Authentication.

When possible, prompt users to enter security credentials at runtime. If you must store credentials, use the cryptographic services provided by the Microsoft Windows .NET Framework.

Stored passwords used to connect to the Distributor are never returned. Accessing this property will generate a PasswordWriteOnlyException exception.

This property is used only when DistributorSecurityMode is set to Standard.