HypConnect

Data provider types: Oracle Essbase, Oracle Hyperion Planning, Oracle Hyperion Financial Management

Note:

Cloud data sources: HypConnect is not supported for cloud data sources. To connect to a cloud data source (for example, an Oracle Planning and Budgeting Cloud source), you must use the HypUIConnect function. See HypUIConnect

Description

HypConnect() logs into a data provider and associates the worksheet with that connection. HypConnect() must be called for each sheet in order to associate this connection with that sheet.

Syntax

HypConnect (vtSheetName, vtUserName, vtPassword, vtFriendlyName)

ByVal vtSheetName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtFriendlyName As Variant

Parameters

vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used.

vtUserName: A valid user name

vtPassword: The password for this user

vtFriendlyName: The friendly connection name of the data provider. This is the connection name created by HypCreateConnection.

Return Value

Returns 0 if successful; otherwise, returns the appropriate error code.

Example

Declare Function HypConnect Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtFriendlyName As Variant) As Long

Sub Example_HypConnect()
   X=HypConnect(Empty, UserName, Password, "My Sample Basic")
End Sub