AdoDotNetConnectionProperties.GetSynonyms Method

Article
10/03/2012

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

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

Syntax

'Declaration
Public Overrides Function GetSynonyms ( _
    propertyName As String _
) As String()

public override string[] GetSynonyms(
    string propertyName
)

public:
virtual array<String^>^ GetSynonyms(
    String^ propertyName
) override

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

public override function GetSynonyms(
    propertyName : String
) : String[]

Parameters

propertyName
Type: System.String

Name of the property for which synonyms are retrieved.

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 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.

Share via