Share via


DataViewManager.GetDataViewHierarchy Method (String, Guid, String, Boolean)

Retrieves data view hierarchy object instance specified by the input parameters and sets the name of the hierarchy root node.

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

Syntax

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

Parameters

  • name
    Type: System.String

    Name of the data view hierarchy to retrieve.

  • provider
    Type: System.Guid

    Unique 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 specified data view hierarchy object instance.

Exceptions

Exception Condition
ArgumentNullException

The connectionString parameter is null.

ArgumentException

The specified provider is not a registered DDEX provider.

Remarks

Passing in a non-null value for the name parameter allows new hierarchies to be created without opening a connection. For existing hierarchies, the name is updated to the specified name.

.NET Framework Security

See Also

Reference

DataViewManager Class

GetDataViewHierarchy Overload

Microsoft.VisualStudio.Data Namespace

CreateDataViewHierarchy

GetDataViewHierarchy