Share via

Job.Description Property

  • Article

Gets or sets the textual description of the job.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property Description As String 
    Get 
    Set
'Usage
Dim instance As Job 
Dim value As String 

value = instance.Description

instance.Description = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public string Description { get; set; }

[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property String^ Description {
    String^ get ();
    void set (String^ value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member Description : string with get, set

function get Description () : String 
function set Description (value : String)

Property Value

Type: System.String
A String value that specifies the textual description of the job.

Examples

The following code example sets the job description.

C#

Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.Description = "Sample Job Description";

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.Description = "Sample Job Description"

See Also

Reference

Job Class

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

sp_add_job (Transact-SQL)

Scheduling Automatic Administrative Tasks in SQL Server Agent