AxisAddHierarchyAsync(AxisType,String,Boolean,Control) Method

Sends an asynchronous request to the OLAP server to add the specified hierarchy to the specified axis.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function AxisAddHierarchyAsync( _
   ByVal axisType As AxisType, _
   ByVal hierarchyUniqueName As String, _
   Optional ByVal update As Boolean, _
   Optional ByVal control As Control _
) As Boolean

C#

public bool AxisAddHierarchyAsync( 
   AxisType axisType,
   string hierarchyUniqueName,
   bool update,
   Control control
)

Parameters

axisType

The axis to which the hierarchy is to be added.

hierarchyUniqueName

The unique name of the Hierarchy to be added. If the specified unique name cannot be resolved, a HierarchyNotFoundException exception is thrown.

update

Optional boolean value indicating whether to update the data source immediately.

The default value is true, which causes the request to be sent to the OLAP server immediately, and raises the AxisAddHierarchyAsyncCompleted event when the server's response has been received.

If false is specified, the request is not sent to the server until the UpdateAsync method is called.

Note that when false is specified, the AxisAddHierarchyAsyncCompleted event does not occur.

control

Optional reference to a Control. If specified, the AxisAddHierarchyAsyncCompleted event is raised on the thread on which this control's handle was created. This approach makes it possible to access control members directly from the event handler.

Return Value

A boolean value indicating whether the method call resulted in any change to the data source. If the specified hierarchy already exists on the specified axis, false is returned and no action is taken.

Remarks

This method returns immediately after issuing the request to the OLAP server so as not to block the calling thread. The actual operation, however, does not occur until the server returns this request, which happens indeterminately.

If the specified hierarchy already exists on the specified axis, it is removed from its current position and added at the end of the list.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2