Share via


IVsDataProvider.Description Property

Gets a description of the DDEX provider.

Namespace:  Microsoft.VisualStudio.Data.Core
Assembly:  Microsoft.VisualStudio.Data.Core (in Microsoft.VisualStudio.Data.Core.dll)

Syntax

'Declaration
ReadOnly Property Description As String
string Description { get; }
property String^ Description {
    String^ get ();
}
abstract Description : string with get
function get Description () : String

Property Value

Type: System.String
A description of the DDEX provider.

Remarks

The description of a DDEX provider is a localized string that can be shown by DDEX clients to end users. One example of this usage is in the data connection Choose Data Source dialog box, where a group box provides information that describes the current selection of DDEX data source and provider.

This property determines the description by calling the GetProperty method with the parameter Description to retrieve a string resource ID. It then calls the GetString method to retrieve the localized string that is associated with that resource ID. If no resource exists, nulla null reference (Nothing in Visual Basic) is returned.

"Use this data provider to connect to SQL Server 2000 or SQL Server 2005" is an example of a value for this property.

.NET Framework Security

See Also

Reference

IVsDataProvider Interface

Microsoft.VisualStudio.Data.Core Namespace