Share via


IVsDataConnectionUIProperties.GetSynonyms Method

When implemented by a class, retrieves an array list of synonyms for a specified property.

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

Syntax

'Declaration
Function GetSynonyms ( _
    key As String _
) As String()
string[] GetSynonyms(
    string key
)
array<String^>^ GetSynonyms(
    String^ key
)
abstract GetSynonyms : 
        key:string -> string[] 
function GetSynonyms(
    key : String
) : String[]

Parameters

  • key
    Type: System.String

    The name of a property for which to retrieve the list of synonyms.

Return Value

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

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", that are both treated as the same property by the data provider.

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

.NET Framework Security

See Also

Reference

IVsDataConnectionUIProperties Interface

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace