DataConnectionProperties.GetSynonyms Method

Article
10/03/2012

Retrieves an array list of synonyms for a specified property.

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

Syntax

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

public string[] GetSynonyms(
    string key
)

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

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

public final 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[]
A list of synonyms for a specified property.

Implements

IVsDataConnectionUIProperties.GetSynonyms(String)

Exceptions

Exception	Condition
ArgumentNullException	The key parameter is nulla null reference (Nothing in Visual Basic).

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 which are 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

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.

Share via