HypConnectionExists
Describes the Oracle Smart View for Office VBA function, HypConnectionExists.
Cloud data provider types: Oracle Essbase, Planning, Planning Modules, Financial Consolidation and Close, Tax Reporting
On-premises data provider types: Oracle Essbase, Oracle Hyperion Planning, Oracle Hyperion Financial Management
Description
HypConnectionExists() checks whether a particular connection name exists in the list of all connections as viewed in the Smart View Panel. The particular connection may or may not be active (connected).
Syntax
HypConnectionExists(vtFriendlyName)
ByVal vtFriendlyName As Variant
Parameters
vtFriendlyName: The name of the connection to search for in the list of all connections. It is not case-sensitive.
Return Value
Boolean. If successful, return value is TRUE; otherwise, return value is FALSE.
Example
Declare Function HypConnectionExists Lib "HsAddin" (ByVal vtFriendlyName As Variant) As Variant
Sub Example_HypConnectionExists
Dim bIsConnection as Boolean
bIsConnection = HypConnectionExists ("Demo_Basic")
End sub