SQL-DMO

Description Property

The Description property specifies informational text for a Microsoft® SQL Server™ or SQLServerAgent object.

Applies To
ConfigValue Object MergeSubscription Object
DistributionArticle Object RegisteredSubscriber Object
DistributionPublication Object ServerRole Object
Job Object TransArticle Object
MergeArticle Object TransPublication Object
MergePublication Object TransPullSubscription Object
MergePullSubscription Object  

Syntax

object.Description [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

String that contains descriptive text

Data Type

String

Modifiable

Read-only for a ConfigValue or ServerRole object. Read/write for all other objects.

Prototype (C/C++)

HRESULT GetDescription(SQLDMO_LPBSTR pRetVal);

HRESULT SetDescription(SQLDMO_LPCSTR NewValue);

Note  SQL-DMO strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.