SetCubeAsync Method

Sends an asynchronous request to the OLAP server to set the specified cube as the data source's current cube.

Syntax

Visual Basic

'Declaration
 
Public Sub SetCubeAsync( _
   ByVal cubeName As String, _
   ByVal update As Boolean, _
   Optional ByVal control As Control _
) 

C#

public void SetCubeAsync( 
   string cubeName,
   bool update,
   Control control
)

Parameters

cubeName

The name of the cube to which the data source's current cube is to be set.

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 GetCubesAsyncCompleted 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 GetCubesAsyncCompleted event does not occur.

control

Optional reference to a Control. If specified, the GetCubesAsyncCompleted 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.

Remarks

The data source's cube, sometimes referred to as a 'hypercube' or 'datacube', defines the set of hierarchies and measures that are available to the consumer.

Changing the data source's currently selected cube triggers re-initialization of the data source.Any previously defined hierarchies and measures are no longer valid, so any cached information that references hierarchies or measures defined by the previously selected cube should be refreshed after calling this method.

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.

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