Export (0) Print
Expand All

Job Methods

The Job type exposes the following members.

  NameDescription
Protected method AddDatabaseContext(StringCollection) Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Protected method AddDatabaseContext(StringCollection, ScriptingOptions) Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.)
Public method AddSharedSchedule Adds a shared schedule to the Microsoft SQL Server Agent job.
Public method Alter Updates any Job object property changes on an instance of Microsoft SQL Server. 
Protected method AlterImpl Activates the object altered event. (Inherited from SqlSmoObject.)
Protected method AlterImplFinish Method called when object altered event finishes. (Inherited from SqlSmoObject.)
Protected method AlterImplInit Method called when object-altered event is intialized. (Inherited from SqlSmoObject.)
Protected method AlterImplWorker Calls the Alter methods. (Inherited from SqlSmoObject.)
Public method ApplyToTargetServer Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
Public method ApplyToTargetServerGroup Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
Protected method BindDefaultImpl Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected method BindRuleImpl Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Protected method CheckCollation Checks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method CheckObjectState(Boolean) Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
Protected method CheckObjectStateImpl Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method CheckVersion100 Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected method CheckVersion80 Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3 Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90 Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90 Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CleanObject Sets the object to unmodified state. (Inherited from SqlSmoObject.)
Public method Create Creates a job on the instance of Microsoft SQL Server as defined by the Job object.
Protected method CreateImpl Creates an object with scripting options. (Inherited from SqlSmoObject.)
Protected method CreateImplFinish Method called when the create event finishes. (Inherited from SqlSmoObject.)
Protected method CreateImplInit Method called when the create event initializes. (Inherited from SqlSmoObject.)
Public method DeleteJobStepLogs(DateTime) Deletes job step log files that are older than the specified date.
Public method DeleteJobStepLogs(Int32) Deletes job step log files that are larger that the specified log ID number.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop() Removes an existing job.
Public method Drop(Boolean) Removes an existing job.
Protected method DropImpl Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method DropImplWorker Calls the drop methods. (Inherited from SqlSmoObject.)
Public method EnumAlerts Enumerates a list of Agent alerts that cause automated execution of the referenced job.
Public method EnumHistory() Enumerates a list of execution history associated with the referenced job.
Public method EnumHistory(JobHistoryFilter) Enumerates a list of execution history associated with the referenced job.
Public method EnumJobStepLogs() Enumerates a list of job step log files for the referenced job.
Public method EnumJobStepLogs(Int32) Enumerates a list of job step log files for the job step with the specified ID value.
Public method EnumJobStepLogs(String) Enumerates a list of job step log files for the job step with the specified name.
Public method EnumJobStepsByID Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value.
Protected method EnumScriptImpl Enumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker Calls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorkerSOChanged Returns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.)
Public method EnumTargetServers Enumerates a list of execution target servers that have been assigned to the referenced job.
Public method Equals (Inherited from Object.)
Protected method ExecuteNonQuery Executes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.)
Protected method Finalize (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceFileStreamScript Generates a script to create data file. (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceScript Generates a script to allocate space in the data file. (Inherited from SqlSmoObject.)
Protected method GetBindDefaultScript Gets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.)
Protected method GetBindRuleScript Gets the script that specifies the binding rules. (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32) Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean) Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameter Assigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameterAsInt Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.)
Protected method GetDBName Do not reference this member directly in your code. It supports the SQL Server infrastructure. Gets the database name that is associated with the object. (Inherited from AgentObjectBase.)
Protected method GetEnumParameter Assigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetFragOptionString Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Protected method GetGuidParameter Assigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32) Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean) Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetRealValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetScriptingOptionsForCreate Gets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerName Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32) Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean) Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetTimeSpanParameterAsInt Assigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method ImplInitialize Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Invoke Runs the job.
Protected method IsObjectDirty Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected method IsVersion80SP3 Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected method IsVersion90AndAbove Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected method MarkDropped Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method PostAlter Method activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected method PostCreate Method activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected method PostDrop Method activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public method PurgeHistory Removes system records maintaining execution history for the referenced job.
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method RemoveAllJobSchedules() Removes all shared and unshared schedules from the job.
Public method RemoveAllJobSchedules(Boolean) Removes all unused schedules from the job.
Public method RemoveAllJobSteps Removes all the job steps associated with the job.
Public method RemoveFromTargetServer Removes an execution target server from the list of target servers maintained for a job.
Public method RemoveFromTargetServerGroup Removes a group of execution target servers from the list of target servers maintained for a job.
Public method RemoveSharedSchedule(Int32) Removes the specified shared schedule from the job.
Public method RemoveSharedSchedule(Int32, Boolean) Removes the specified shared schedule from the job and keeps unused schedules.
Public method Rename Renames the job.
Protected method RenameImpl Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job as specified by the scripting options.
Protected method ScriptAlter Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected method ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method ScriptCreate Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected method ScriptDdl Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected method ScriptDrop Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected method ScriptImpl() Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImplWorker Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptOwner Alters the script owner authorization. (Inherited from NamedSmoObject.)
Protected method ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected method SetSchemaOwned Sets the schema owned value. (Inherited from NamedSmoObject.)
Public method Start() Runs the referenced job.
Public method Start(String) Runs the referenced job starting at the specified job step.
Public method Stop Stops executing the referenced job.
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl Not implemented. (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Explicit interface implemetation Private method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.GetUrn Gets the Unified Resource Name of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetation Private method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Top

Community Additions

ADD
Show:
© 2014 Microsoft