SnapshotGenerationAgent.SecureDistributorPassword Property

  • Article

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

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

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

/** @property */
public SecureString get_SecureDistributorPassword ()

/** @property */
public void set_SecureDistributorPassword (SecureString value)

public function get SecureDistributorPassword () : SecureString

public function set SecureDistributorPassword (value : 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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

SnapshotGenerationAgent Class
SnapshotGenerationAgent Members
Microsoft.SqlServer.Replication Namespace