HypGetLinkMacro

Data provider types: Essbase, Planning (ad hoc only), Oracle Planning and Budgeting Cloud (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.

Syntax

HypGetLinkMacro (vtMacroName)

ByRef vtMacroName As Variant

Parameters

vtMacroName: Output parameter, 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 Example_HypGetLinkMacro()
   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