RemoveJobByID Method
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The RemoveJobByID method drops the SQL Server Agent job identified and removes the referencing Job object from the Jobs collection.
Syntax
object
.RemoveJobByID(
JobID
)
Parts
- object
Expression that evaluates to an object in the Applies To list.
- JobID
String representation of the system-generated, globally unique identifier for a job.
Prototype (C/C++)
HRESULT RemoveJobByID(
SQLDMO_LPCSTR NewVal);
Remarks
For SQL Server Agent, a job identifier is a 32-byte string representing a hexadecimal number.
The RemoveJobByID method completely removes a job. When a multiserver administration job is targeted on the master server, the master server posts job-delete instructions to each execution target server. The indicated job is deleted at the master server immediately. Each target server deletes its local copy of the job when it next successfully polls the master server and retrieves the delete instruction.
Note
Removing a SQL Server Agent job by using the RemoveJobByID method requires appropriate permission. The Microsoft SQL Server login used for SQLServer object connection must be the owner of the job indicated by the JobID argument or a member of a role with greater privilege.