DataSource.GetDescription Method

Retrieves a description for a data source combined with a specified DDEX provider.

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

Syntax

'Declaration
Public MustOverride Function GetDescription ( _
    provider As Guid _
) As String

public abstract string GetDescription(
    Guid provider
)

public:
virtual String^ GetDescription(
    Guid provider
) abstract

abstract GetDescription : 
        provider:Guid -> string

public abstract function GetDescription(
    provider : Guid
) : String

Parameters

• provider
  Type: System.Guid

  A DDEX provider GUID.

Return Value

Type: System.String
Returns the string literal description.

Exceptions

Exception	Condition
ArgumentException	The provider specified is not a registered DDEX provider.

Remarks

An example description might provide information like this: "Use this data source and provider combination to connect to Microsoft SQL Server versions 7, 2000 and 2005 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.

See Also

Reference

DataSource Class

Microsoft.VisualStudio.Data Namespace