EssVGetCurrency

Description

Gets Essbase currency information from the specified worksheet.

Syntax

EssVGetCurrency(sheetName)
ByVal sheetName As Variant

Parameters

sheetName

Text name of worksheet containing the currency information. sheetName is of the form "[Book.xls]Sheet". If sheetName is Null or Empty, the active worksheet is used.

Return Value

Returns a string describing the current currency rate based on the member name in the currency outline. For example, if the active currency setting is Canadian dollars, Essbase returns (CN$). If no currency information exists, an empty string (or "") is returned. If an error occurs, a number is returned. 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 EssVGetCurrency Lib "ESSEXCLN.XLL" (ByVal sheetName As Variant) As Variant

Sub GetCurr()
X=EssVGetCurrency(Empty)
MsgBox ("Currency is: " + X)
End Sub