IVsDataSource.GetDescription Method
Gets a localized description of the selection of the DDEX data source combined with a specific supporting DDEX provider.
Namespace: Microsoft.VisualStudio.Data.Core
Assembly: Microsoft.VisualStudio.Data.Core (in Microsoft.VisualStudio.Data.Core.dll)
Syntax
'Declaration
Function GetDescription ( _
provider As Guid _
) As String
string GetDescription(
Guid provider
)
String^ GetDescription(
Guid provider
)
abstract GetDescription :
provider:Guid -> string
function GetDescription(
provider : Guid
) : String
Parameters
provider
Type: System.GuidThe identifier of a supporting DDEX provider.
Return Value
Type: System.String
A localized description of the selection of this DDEX data source combined with a specific supporting DDEX provider, or nulla null reference (Nothing in Visual Basic) if no description exists.
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 combined description returned by this method describes a particular selection of the DDEX data source and a supporting provider. It is computed by calling the GetProperty method, passing in the specified provider and the parameter UsingDescription, to retrieve a string resource ID. It then calls the GetString method to retrieve the localized string that is associated with the resource ID.
Note
DDEX in Visual Studio 2005 does not distinguish between the simple description that is returned by the Description property and the combined descriptions that are returned by this method. In the current release of Visual Studio, these are distinguished by the strings SourceDescription and UsingDescription. For backward compatibility, the current runtime still looks for the old Description value if it does not first find a value for UsingDescription.
An example of a value for this property might be "Use this selection to connect to Microsoft SQL Server 2000 and SQL Server 2005 by using the .NET Framework Data Provider for SQL Server."
.NET Framework Security
- 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.