RemoveFromTargetServer Method

SQL-DMO

Syntax

object.RemoveFromTargetServer( Val )

Parts

object

Expression that evaluates to an object in the Applies To list.

Val

String that specifies an instance of Microsoft® SQL Server™ by name.

Prototype (C/C++)

HRESULT RemoveFromTargetServer(
SQLDMO_LPCSTR NewVal);

Remarks

Before a SQL Server Agent job can execute, the job must have at least one step and an execution target.

When using SQL-DMO to create, schedule, and run SQLServerAgent jobs, use either the ApplyToTargetServer or ApplyToTargetServerGroup method to add an execution target. When a single execution target has been added by using the ApplyToTargetServer method, use the RemoveFromTargetServer method to remove the execution target.

When a job is targeted to run on the server running SQLServerAgent, specify the server name using the string (local) when removing the execution target.

Note  When an execution target is removed for a multiserver administration job, the master server (MSX) posts an instruction to the target server (TSX) indicating that the TSX should drop its local copy of the job. The job is removed from the TSX but remains defined at the MSX. To completely remove a job from all servers participating in multiserver administration, use a job removing method such as the Remove method of the Job object or the RemoveJobByID method of the JobServer object.