Share via


Job.Alter Method

Updates any Job object property changes on an instance of Microsoft SQL Server. 

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Sub Alter
'Usage
Dim instance As Job

instance.Alter()
public void Alter()
public:
virtual void Alter() sealed
abstract Alter : unit -> unit  
override Alter : unit -> unit
public final function Alter()

Implements

IAlterable.Alter()

Remarks

The Alter method updates any changes that have been made to the properties of the Job object since the Job object was created, or since the last Alter statement. The modifications are combined and sent to the instance of SQL Server in a single network trip to the instance of SQL Server.

Users must have Execute permissions on the msdb.dbo.sp_help_operator stored procedure to script or alter properties on a SQL Server 2000 job.

When connected to an instance of SQL Server 2000, users other than sa do not automatically have permissions to run the Alter method. The system administrator must grant Execute permissions on the msdb.dbo.sp_help_operator stored procedure to any user who has to script or alter a SQL Server 2000 job.

Examples

The following code example creates a job, changes a job property, and calls Alter to update the instance.

C#

Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.Create();
jb.OperatorToEmail = "OperatorName";
jb.Alter();

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.Create()
$jb.OperatorToEmail = "OperatorName"
$jb.Alter()

See Also

Reference

Job Class

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

Scheduling Automatic Administrative Tasks in SQL Server Agent

sp_update_job (Transact-SQL)