HypConnectionExists

Data source types: Essbase, Planning, Financial Management, Hyperion Enterprise

Description

HypConnectionExists() is used to check if 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 (i.e., connected).

Syntax

HypConnectionExists(vtConnectionName)

ByVal vtConnectionName as Variant

Parameters

vtConnectionName: 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 vtConnectionName As Variant) As Variant

Sub Sample_SetActiveConnection
   Dim bIsConnection as Boolean
   bIsConnection = HypConnectionExists (“Demo_Basic”)
End sub