The RemoveJobByID method drops the SQL Server Agent job identified and removes the referencing Job object from the Jobs collection.
object.RemoveJobByID( JobID )
| Part | Description |
|---|---|
| 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. |
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 (MSX), the MSX posts job-delete instructions to each execution target server (TSX). The indicated job is deleted at the MSX immediately. Each TSX deletes its local copy of the job when it next successfully polls the MSX and retrieves the delete instruction.
Note Removing a SQL Server Agent job by using the RemoveJobByID method requires appropriate privilege. 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.
HRESULT RemoveJobByID(
SQLDMO_LPCSTR NewVal);