EssVZoomOut

Description

Collapses the view of data based on the selected members.

Syntax

EssVZoomOut(sheetName, range, selection)
ByVal sheetName As Variant
ByVal range As Variant
ByVal selection As Variant

Parameters

sheetName

Text name of worksheet to operate on. sheetName is of the form "[Book.xls]Sheet". If sheetName is Null or Empty, the active worksheet is used.

range

Range object which refers to the data to be used as the source of the zoom. If range is Null or Empty, the whole worksheet is used.

selection

Range object which refers to the members that are zoomed out. If selection is Null or Empty, the active cell is used.

Return Value

Returns 0 if successful. A negative number indicates a local failure (see VBA Return Values). A return value greater than zero indicates a failure on the server.

Example

Declare Function EssVZoomOut Lib "ESSEXCLN.XLL" (ByVal sheetName As Variant, ByVal range As Variant, ByVal selection As Variant) As Long

Sub UnZoomData()
X=EssVZoomOut("[Book2.xls]Sheet1", Null, RANGE("B3"))
If X = 0 Then
   MsgBox("Zoom-out successful.")
Else
   MsgBox("Zoom-out failed.")
End If
End Sub