Freigeben über


DataViewManager.GetDataViewHierarchy Method (Guid, String, Boolean)

Retrieves a data view hierarchy with the specified DDEX provider and connection information.

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

Syntax

'Declaration
Public Function GetDataViewHierarchy ( _
    provider As Guid, _
    connectionString As String, _
    encryptedString As Boolean _
) As Object
public Object GetDataViewHierarchy(
    Guid provider,
    string connectionString,
    bool encryptedString
)
public:
Object^ GetDataViewHierarchy(
    Guid provider, 
    String^ connectionString, 
    bool encryptedString
)
member GetDataViewHierarchy : 
        provider:Guid * 
        connectionString:string * 
        encryptedString:bool -> Object 
public function GetDataViewHierarchy(
    provider : Guid, 
    connectionString : String, 
    encryptedString : boolean
) : Object

Parameters

  • provider
    Type: System.Guid
    The identifier of a DDEX provider.
  • connectionString
    Type: System.String
    An unencrypted or encrypted string containing connection information.
  • encryptedString
    Type: System.Boolean
    Indicates whether the connectionString parameter is encrypted.

Return Value

Type: System.Object
Returns a data view hierarchy with the specified DDEX provider and connection information.

Exceptions

Exception Condition
ArgumentNullException

The connectionString parameter is null.

ArgumentException

The specified provider is not a registered DDEX provider.

Remarks

If there exists a data view hierarchy with connection information equivalent to the information passed in, the method returns the existing data view hierarchy. Otherwise, a new data view hierarchy is created.

The creation of this hierarchy may cause a connection to be opened in order to generate the name of the hierarchy root node. To avoid opening the connection, call the other GetDataViewHierarchy method, passing in a non-nulla null reference (Nothing in Visual Basic) value for the name parameter.

.NET Framework Security

See Also

Reference

DataViewManager Class

GetDataViewHierarchy Overload

Microsoft.VisualStudio.Data Namespace