Job Job Job Class

Definition

The Job class represents a Microsoft SQL Server Agent job.

public ref class Job sealed : Microsoft::SqlServer::Management::Smo::Agent::AgentObjectBase, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDropIfExists, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Common::IRenamable, Microsoft::SqlServer::Management::Smo::IScriptable
public sealed class Job : Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDropIfExists, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Smo.IScriptable
Public NotInheritable Class Job
Inherits AgentObjectBase
Implements IAlterable, ICreatable, IDropIfExists, IDroppable, IRenamable, IScriptable
Inheritance
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable Microsoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatable Microsoft.SqlServer.Management.Common.IDropIfExistsMicrosoft.SqlServer.Management.Common.IDropIfExistsMicrosoft.SqlServer.Management.Common.IDropIfExists Microsoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppable Microsoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamable IScriptableIScriptableIScriptable

Examples

Scheduling Automatic Administrative Tasks in SQL Server Agent

Remarks

To get or set Job object properties, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.

To create a job, users must be a member of the SQLAgentUserRole, SQLAgentReaderRole, and SQLAgentOperatorRole database roles on the MSDB database, or be a member of the sysadmin fixed server role.

To drop a job, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Constructors

Job() Job() Job()

Initializes a new instance of the Job class.

Job(JobServer, String) Job(JobServer, String) Job(JobServer, String)

Initializes a new instance of the Job class on the specified instance of Microsoft SQL Server Agent and with the specified name.

Job(JobServer, String, Int32) Job(JobServer, String, Int32) Job(JobServer, String, Int32)

Initializes a new instance of the Job class on the specified instance of SQL Server Agent and with the specified name and category

Properties

Category Category Category

Gets or sets the category to which the job belongs.

CategoryID CategoryID CategoryID

Gets the ID value that uniquely identifies the job category.

CategoryType CategoryType CategoryType

Gets or sets the type of category, with respect to local or multiserver jobs.

CurrentRunRetryAttempt CurrentRunRetryAttempt CurrentRunRetryAttempt

Gets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully.

CurrentRunStatus CurrentRunStatus CurrentRunStatus

Gets the current execution status of the job.

CurrentRunStep CurrentRunStep CurrentRunStep

Gets information about the job step that is currently running.

DateCreated DateCreated DateCreated

Gets the date and time when the job was created.

DateLastModified DateLastModified DateLastModified

Gets the date and time when the job was last modified.

DeleteLevel DeleteLevel DeleteLevel

Gets or sets the completion action that determines whether to delete the job definition when the job finishes execution.

Description Description Description

Gets or sets the textual description of the job.

EmailLevel EmailLevel EmailLevel

Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution.

EventLogLevel EventLogLevel EventLogLevel

Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution.

ExecuteForScalar ExecuteForScalar ExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.

(Inherited from SqlSmoObject)
ExecutionManager ExecutionManager ExecutionManager

Gets the object to execute to the manager.

(Inherited from SqlSmoObject)
HasSchedule HasSchedule HasSchedule

Gets the Boolean property value that specifies whether the job has at least one schedule.

HasServer HasServer HasServer

Gets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations.

HasStep HasStep HasStep

Gets the Boolean property value that specifies whether the job has at least one job step.

IsEnabled IsEnabled IsEnabled

Gets or sets the Boolean property value that specifies whether the job is enabled.

IsTouched IsTouched IsTouched

Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.

(Inherited from SqlSmoObject)
JobID JobID JobID

Gets the job ID value.

JobSchedules JobSchedules JobSchedules

Gets a collection of JobSchedule objects that represent the schedules assigned to the job.

JobSteps JobSteps JobSteps

Gets a collection of JobStep objects that represent the job steps defined for the job.

JobType JobType JobType

Gets the job type, which specifies whether the job is local or multiserver.

LastRunDate LastRunDate LastRunDate

Gets the date and time when the job was last run.

LastRunOutcome LastRunOutcome LastRunOutcome

Gets the result of the job from the last time it completed execution.

Name Name Name

Gets or sets the name of the Job.

NetSendLevel NetSendLevel NetSendLevel

Gets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution.

NextRunDate NextRunDate NextRunDate

Gets the date and time when the job is next scheduled to run.

NextRunScheduleID NextRunScheduleID NextRunScheduleID

Gets the ID value of the schedule that is responsible for the next execution of the job.

ObjectInSpace ObjectInSpace ObjectInSpace

Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
OperatorToEmail OperatorToEmail OperatorToEmail

Gets or sets the operator that receives notification by e-mail when the job finishes execution.

OperatorToNetSend OperatorToNetSend OperatorToNetSend

Gets or sets the operator that receives a net-send notification when the job finishes execution.

OperatorToPage OperatorToPage OperatorToPage

Gets or sets the operator that receives a pager notification when the job finishes execution.

OriginatingServer OriginatingServer OriginatingServer

Gets the name of the server that is acting as the master server in a multiserver job.

OwnerLoginName OwnerLoginName OwnerLoginName

Gets or sets the owner of the job.

PageLevel PageLevel PageLevel

Gets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution.

Parent Parent Parent

Gets or sets the JobServer object that is the parent of the Job object.

Properties Properties Properties

Gets a collection of Property objects that represent the object properties.

(Inherited from SqlSmoObject)
ScalarResult ScalarResult ScalarResult

Gets the scalar result for the referenced object.

(Inherited from SqlSmoObject)
StartStepID StartStepID StartStepID

Gets or sets the ID value of the first job step in the sequence to be executed.

State State State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
Urn Urn Urn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.

(Inherited from SqlSmoObject)
UserData UserData UserData

Gets or sets user-defined data associated with the referenced object.

(Inherited from SmoObjectBase)
VersionNumber VersionNumber VersionNumber

Gets a system-maintained value that is incremented every time the job is modified.

Methods

AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.

(Inherited from SqlSmoObject)
AddSharedSchedule(Int32) AddSharedSchedule(Int32) AddSharedSchedule(Int32)

Adds a shared schedule to the Microsoft SQL Server Agent job.

Alter() Alter() Alter()

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

AlterImpl() AlterImpl() AlterImpl()

Activates the object altered event.

(Inherited from SqlSmoObject)
AlterImplWorker() AlterImplWorker() AlterImplWorker()

Calls the Alter methods.

(Inherited from SqlSmoObject)
ApplyToTargetServer(String) ApplyToTargetServer(String) ApplyToTargetServer(String)

Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.

ApplyToTargetServerGroup(String) ApplyToTargetServerGroup(String) ApplyToTargetServerGroup(String)

Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.

BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.

(Inherited from SqlSmoObject)
BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean)

Binds the rule schema to the rule and columns identified by the parameters.

(Inherited from SqlSmoObject)
CheckObjectState() CheckObjectState() CheckObjectState()

Validates the state of the referenced object.

(Inherited from SqlSmoObject)
CheckObjectState(Boolean) CheckObjectState(Boolean) 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)
CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean)

Checks the state of a SqlSmoObject.

(Inherited from SqlSmoObject)
CleanObject() CleanObject() CleanObject()

Sets the object to its unmodified state.

(Inherited from SqlSmoObject)
Create() Create() Create()

Creates a job on the instance of Microsoft SQL Server as defined by the Job object.

CreateImpl() CreateImpl() CreateImpl()

Creates an object with scripting options.

(Inherited from SqlSmoObject)
DeleteJobStepLogs(DateTime) DeleteJobStepLogs(DateTime) DeleteJobStepLogs(DateTime)

Deletes job step log files that are older than the specified date.

DeleteJobStepLogs(Int32) DeleteJobStepLogs(Int32) DeleteJobStepLogs(Int32)

Deletes job step log files that are larger that the specified log ID number.

Discover() Discover() Discover()

Discovers a list of type Object.

(Inherited from SqlSmoObject)
Drop() Drop() Drop()

Removes an existing job.

Drop(Boolean) Drop(Boolean) Drop(Boolean)

Removes an existing job.

DropIfExists() DropIfExists() DropIfExists()

Drops the Job object if exists in the server.

DropImpl(Boolean) DropImpl(Boolean) DropImpl(Boolean)

Drops a SqlSmoObject.

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean)

Drops the IMPL worker.

(Inherited from SqlSmoObject)
EnumAlerts() EnumAlerts() EnumAlerts()

Enumerates a list of Agent alerts that cause automated execution of the referenced job.

EnumHistory() EnumHistory() EnumHistory()

Enumerates a list of execution history associated with the referenced job.

EnumHistory(JobHistoryFilter) EnumHistory(JobHistoryFilter) EnumHistory(JobHistoryFilter)

Enumerates a list of execution history associated with the referenced job.

EnumJobStepLogs() EnumJobStepLogs() EnumJobStepLogs()

Enumerates a list of job step log files for the referenced job.

EnumJobStepLogs(Int32) EnumJobStepLogs(Int32) EnumJobStepLogs(Int32)

Enumerates a list of job step log files for the job step with the specified ID value.

EnumJobStepLogs(String) EnumJobStepLogs(String) EnumJobStepLogs(String)

Enumerates a list of job step log files for the job step with the specified name.

EnumJobStepsByID() EnumJobStepsByID() EnumJobStepsByID()

Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value.

EnumTargetServers() EnumTargetServers() EnumTargetServers()

Enumerates a list of execution target servers that have been assigned to the referenced job.

ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.

(Inherited from SqlSmoObject)
ExecuteRenameQuery(String) ExecuteRenameQuery(String) ExecuteRenameQuery(String)

Executes the rename query for the object.

(Inherited from NamedSmoObject)
FormatSqlVariant(Object) FormatSqlVariant(Object) FormatSqlVariant(Object)

Formats an object as Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.

(Inherited from SqlSmoObject)
GenerateAlterEvent() GenerateAlterEvent() GenerateAlterEvent()

Generates the alter event with the specified value.

(Inherited from SqlSmoObject)
GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object)

Generates alter event with the specified URN and inner object value.

(Inherited from SqlSmoObject)
GetContextDB() GetContextDB() GetContextDB()

Gets the context database that is associated with this object.

(Inherited from SqlSmoObject)
GetDBName() GetDBName() GetDBName()

Gets the database name that is associated with the object.

(Inherited from AgentObjectBase)
GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption)

Gets a FragmentationOption object as a string value.

(Inherited from SqlSmoObject)
GetPropValue(String) GetPropValue(String) GetPropValue(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptional(String) GetPropValueOptional(String) GetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetRealValue(Property, Object) GetRealValue(Property, Object) GetRealValue(Property, Object)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetServerName() GetServerName() GetServerName()

Gets the name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetServerObject() GetServerObject() GetServerObject()

Gets the server of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetSqlServerVersionName() GetSqlServerVersionName() GetSqlServerVersionName()

Gets the version name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[])

Initializes the fields of the SqlSmoObject object.

(Inherited from SqlSmoObject)
Initialize() Initialize() Initialize()

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
Initialize(Boolean) Initialize(Boolean) Initialize(Boolean)

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
Invoke() Invoke() Invoke()

Runs the job.

IsObjectDirty() IsObjectDirty() 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)
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized()

Verifies whether the object has been initialized.

(Inherited from SqlSmoObject)
IsObjectInSpace() IsObjectInSpace() IsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
IsSupportedProperty(String) IsSupportedProperty(String) IsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.

(Inherited from SqlSmoObject)
IsVersion80SP3() IsVersion80SP3() IsVersion80SP3()

Determines whether the version of SQL Server is SQL Server 2000 with SP3.

(Inherited from SqlSmoObject)
IsVersion90AndAbove() IsVersion90AndAbove() IsVersion90AndAbove()

Determines whether the version of SQL Server is SQL Server 2005 or later.

(Inherited from SqlSmoObject)
MarkDropped() MarkDropped() MarkDropped()

Sets the SqlSmoState to dropped.

(Inherited from SqlSmoObject)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.

(Inherited from SqlSmoObject)
PostAlter() PostAlter() PostAlter()

The method that is activated after the SqlSmoObject is altered.

(Inherited from SqlSmoObject)
PostCreate() PostCreate() PostCreate()

The method that is activated after the SqlSmoObject is created.

(Inherited from SqlSmoObject)
PostDrop() PostDrop() PostDrop()

The method that is activated after the SqlSmoObject is dropped.

(Inherited from SqlSmoObject)
PurgeHistory() PurgeHistory() PurgeHistory()

Removes system records maintaining execution history for the referenced job.

Refresh() Refresh() Refresh()

Refreshes the object and retrieves properties when the object is next accessed.

(Inherited from SqlSmoObject)
RemoveAllJobSchedules() RemoveAllJobSchedules() RemoveAllJobSchedules()

Removes all shared and unshared schedules from the job.

RemoveAllJobSchedules(Boolean) RemoveAllJobSchedules(Boolean) RemoveAllJobSchedules(Boolean)

Removes all unused schedules from the job.

RemoveAllJobSteps() RemoveAllJobSteps() RemoveAllJobSteps()

Removes all the job steps associated with the job.

RemoveFromTargetServer(String) RemoveFromTargetServer(String) RemoveFromTargetServer(String)

Removes an execution target server from the list of target servers maintained for a job.

RemoveFromTargetServerGroup(String) RemoveFromTargetServerGroup(String) RemoveFromTargetServerGroup(String)

Removes a group of execution target servers from the list of target servers maintained for a job.

RemoveSharedSchedule(Int32) RemoveSharedSchedule(Int32) RemoveSharedSchedule(Int32)

Removes the specified shared schedule from the job.

RemoveSharedSchedule(Int32, Boolean) RemoveSharedSchedule(Int32, Boolean) RemoveSharedSchedule(Int32, Boolean)

Removes the specified shared schedule from the job and keeps unused schedules.

Rename(String) Rename(String) Rename(String)

Renames the job.

RenameImpl(String) RenameImpl(String) RenameImpl(String)

This method supports the SMO infrastructure and is not intended to be used directly from your code.

(Inherited from NamedSmoObject)
RenameImplWorker(String) RenameImplWorker(String) RenameImplWorker(String)

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

(Inherited from NamedSmoObject)
Script() Script() Script()

Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job.

Script(ScriptingOptions) Script(ScriptingOptions) 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.

ScriptImpl() ScriptImpl() ScriptImpl()

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions)

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.

(Inherited from SqlSmoObject)
SetSchemaOwned() SetSchemaOwned() SetSchemaOwned()

Sets the schema owned value for the named Smo object.

(Inherited from NamedSmoObject)
Start() Start() Start()

Runs the referenced job.

Start(String) Start(String) Start(String)

Runs the referenced job starting at the specified job step.

Stop() Stop() Stop()

Stops executing the referenced job.

ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String)

Throws the object if above version 100.

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String)

Throws SqlSmoObject if version is above 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String)

Throws exception if the version is below 100.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String)

Throws the object if the version belows 110.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String)

Throws the SqlSmoObject if version is below 110Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String)

Throws the object if the version is below 120.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String)

Throws the object if the version belows 120 property.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String)

Throws the object if the version is below 130.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String)

Throws an object if BelowVersion130Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String)

Throws the object if the version is below 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3()

Throws an exception if the version is below 80SP3.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String)

Throws the object if the version is below 90.

(Inherited from SqlSmoObject)
ToString() ToString() ToString()

Returns a String that represents the referenced object.

(Inherited from SqlSmoObject)
TouchImpl() TouchImpl() TouchImpl()

Implements a touch object.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.

(Inherited from SqlSmoObject)
UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.

(Inherited from SqlSmoObject)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Fields

m_ExtendedProperties m_ExtendedProperties m_ExtendedProperties

Represents a property that is defined to extend the properties provided by a SqlSmoObject.

(Inherited from SqlSmoObject)
singletonParent singletonParent singletonParent

Represents the singleton parent.

(Inherited from SqlSmoObject)

Explicit Interface Implementations

IAlienObject.Discover() IAlienObject.Discover() IAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot()

Returns the root of the domain.

(Inherited from SqlSmoObject)
IAlienObject.GetParent() IAlienObject.GetParent() 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)
IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String)

Gets the type of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() IAlienObject.GetUrn() IAlienObject.GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.Resolve(String) IAlienObject.Resolve(String) IAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.

(Inherited from SqlSmoObject)
IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.

(Inherited from SqlSmoObject)
ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet() 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)

Events

PropertyChanged PropertyChanged PropertyChanged

Represents the event that occurs when a property is changed.

(Inherited from SqlSmoObject)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Represents the event that occurs when property metadata changes.

(Inherited from SqlSmoObject)

Applies to