AdoDotNetConnectionProperties.GetSynonyms Method

Retrieves an array list of synonyms for a specified data connection property.

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

Syntax

'Declaration
Public Overridable Function GetSynonyms ( _
    key As String _
) As String()

public virtual string[] GetSynonyms(
    string key
)

public:
virtual array<String^>^ GetSynonyms(
    String^ key
)

abstract GetSynonyms : 
        key:string -> string[] 
override GetSynonyms : 
        key:string -> string[] 

public function GetSynonyms(
    key : String
) : String[]

Parameters

• key
  Type: System.String

  Name of the property for which synonyms are retrieved.

Return Value

Type: array<System.String[]
A list of synonyms for a specified property.

Implements

IVsDataConnectionUIProperties.GetSynonyms(String)

Remarks

A synonym is a property name that behaves like an alias, allowing a given property to be called by two or more names. For example, there might be two property names, "Server" and "Data Source", both of which are treated as the same property by the DDEX provider.

The array of values returned includes all synonyms for the specified property name, not including the specified property name.

.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

AdoDotNetConnectionProperties Class

Microsoft.VisualStudio.Data.Framework.AdoDotNet Namespace