HypGetLinkMacro

Data source types: Essbase, Planning (ad hoc only)Financial Management, (ad hoc only), Hyperion Enterprise (ad hoc only)

Description

HypGetLinkMacro() returns the macro name currently set to be run to perform the dynamic link query.

Note:

This function is used specifically with dynamic link views, as described in VBA Functions and Dynamic Link Views.

Syntax

HypGetLinkMacro (vtMacroName)

ByRef vtMacroName As Variant

Parameters

vtMacroName: Output. Returns the currently set macro name.

Return Value

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

Example

Declare Function HypGetLinkMacro Lib "HsAddin" (ByRef vtMacroName As Variant) As Long

Sub Auto_Open()
   Dim Macroname as Variant
   Sts = HypUseLinkMacro(True)
   Sts = HypSetLinkMacro(“Sheet1.Macro8”)
   Sts = HypGetLinkMacro(Macroname)
   If (StrComp(MacroName, "Sheet1.Macro8")) Then
      MsgBox ("Error Occurred")
   End If
End Sub