IVsDataSource.Description Property
Gets the basic description of the DDEX data source.
Namespace: Microsoft.VisualStudio.Data.Core
Assembly: Microsoft.VisualStudio.Data.Core (in Microsoft.VisualStudio.Data.Core.dll)
Syntax
ReadOnly Property Description As String
Dim instance As IVsDataSource
Dim value As String
value = instance.Description
string Description { get; }
property String^ Description {
String^ get ();
}
function get Description () : String
Property Value
Type: System.String
The basic description of the DDEX data source.
Remarks
The description of a DDEX data source is a localized string that can be displayed by DDEX clients to end users. One example of this occurs in the data connection Choose Data Source dialog box, where a DDEX data source and provider are selected by the user.
The basic description returned by this property describes the DDEX data source only. Additional descriptions, which you can return by calling the GetDescription method, supply combined descriptions of the DDEX data source and a particular supporting provider.
This property determines the basic description by calling the GetProperty method, passing in the default supporting provider (if there is one) and the parameter SourceDescription, to retrieve a string resource ID. If this fails, the property just starts iterating through the supporting providers, querying each for the same property until a non-null value is returned. It then calls the GetString method to retrieve the localized string that is associated with the resource ID. If no resource exists, nulla null reference (Nothing in Visual Basic) is returned.
An example value for this property might be "Use this data source to connect to SQL Server 2000 and SQL Server 2005".
Permissions
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.