ReplicationServer.ChangeReplicationServerPasswords Method (ReplicationSecurityMode, String, String)

Article
12/03/2008

Changes all stored instances of the password for a login maintained on the replication server.

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntax

'Declaration
Public Sub ChangeReplicationServerPasswords ( _
    securityMode As ReplicationSecurityMode, _
    login As String, _
    password As String _
)

public void ChangeReplicationServerPasswords (
    ReplicationSecurityMode securityMode,
    string login,
    string password
)

public:
void ChangeReplicationServerPasswords (
    ReplicationSecurityMode securityMode, 
    String^ login, 
    String^ password
)

public void ChangeReplicationServerPasswords (
    ReplicationSecurityMode securityMode, 
    String login, 
    String password
)

public function ChangeReplicationServerPasswords (
    securityMode : ReplicationSecurityMode, 
    login : String, 
    password : String
)

Parameters

securityMode
Is the ReplicationSecurityMode value that specifies whether the login is used for Windows Authentication or SQL Server Authentication.

password
Is the password being changed.

Exceptions

Exception type	Condition
ArgumentException	When the values of login or password are longer than 128 Unicode characters or contain null characters.

Remarks

The ChangeReplicationServerPasswords method is used to update the password for a login used by replication agents to connect to other servers in the replication topology after the password for this login has been changed. This method is used instead of individually changing the password for each stored instance of the login used for each agent connection.

The ChangeReplicationServerPasswords method can only be called by a member of the sysadmin fixed server role on the replication server.

Calling ChangeReplicationServerPasswords is equivalent to executing sp_changereplicationserverpasswords (Transact-SQL).

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