sp_changesubscriptiondtsinfo

Changes the DTS package properties of a subscription. This stored procedure is executed at the Subscriber on the subscription database.

Syntax

sp_changesubscriptiondtsinfo [ [ @job_id = ] job_id ]
    [ , [ @dts_package_name = ] 'dts_package_name' ]
    [ , [ @dts_package_password = ] 'dts_package_password' ]
    [ , [ @dts_package_location = ] 'dts_package_location' ]

Arguments

[@job_id =] job_id

Is the job ID of the Distribution Agent for the push subscription. job_id is varbinary(16), with no default. To find the Distribution Job ID, run sp_helpsubscription or sp_helppullsubscription.

[@dts_package_name = ] 'dts_package_name'

Specifies the name of the DTS package. dts_package_name is a sysname, with a default of NULL. For example, to specify a package of DTSPub_Package, the parameter would be @dts_package_name = N'DTSPub_Package'.

[@dts_package_password = ] 'dts_package_password'

Specifies the password on the package, if there is one. dts_package_password is  sysname with a default of NULL, which specifies that the password property is to be left unchanged. If an empty string is put in the parameter, this specifies that the DTS package is to have no password.

[@dts_package_location = ] 'dts_package_location'

Specifies the package location. dts_package_location is a nvarchar(12), with a default of NULL, which specifies that the package location is to be left unchanged. The location of the package can be changed to distributor or subscriber.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_changesubscriptiondtsinfo is used for snapshot replication and transactional replication that are push subscriptions only.

Permissions

Only members of the sysadmin fixed server role can execute sp_changesubscriptiondtsinfo.