Share via


DataConnectionProperties.GetSynonyms Method

Retrieves an array list of synonyms for a specified property.

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

Syntax

'Declaration
Public Overridable Function GetSynonyms ( _
    propertyName As String _
) As String()
public virtual string[] GetSynonyms(
    string propertyName
)
public:
virtual array<String^>^ GetSynonyms(
    String^ propertyName
)
abstract GetSynonyms : 
        propertyName:string -> string[] 
override GetSynonyms : 
        propertyName:string -> string[] 
public function GetSynonyms(
    propertyName : String
) : String[]

Parameters

  • propertyName
    Type: System.String
    The name of a property for which to retrieve the list of synonyms.

Return Value

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

Exceptions

Exception Condition
ArgumentNullException

The propertyName parameter is null.

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

See Also

Reference

DataConnectionProperties Class

Microsoft.VisualStudio.Data Namespace