GefProcAction.GetOverlayScreenEx2 (method)

Retrieves the configuration information for the action.

Syntax:

Boolean = object.GetOverlayScreenEx2 ( ScreenName, BaseProject, SendPublicVarValues, VariableValues )

Parameters:

ScreenName As VARIANT* -

BaseProject As VARIANT* -

SendPublicVarValues As VARIANT_BOOL* -

VariableValues As VARIANT* - Pass in an existing CoCimSafeArray3 object. It will be filled in with a two dimensional array containing the initial variable values configured for the action. (Note: In VBScript and VBA/VB, you may pass a Variant and this function will return a native array.)

Description:

This method is valid only if the Type of the action is GefActionOverlayScreen.

The arguments correspond to the fields in the action panel of the Procedure Information dialog box.

Example:

Sub GefProcAction_GetOverlayScreen()

  Dim oCimObj As GefObject
  Dim oCimProcs As GefProcedures
  Dim oCimProc As GefProcedure
  Dim oCimProcActs As GefProcActions
  Dim oCimProcAct As GefProcAction
  Dim strScrName As String
  Dim strProject As String
  Dim bSendPubVarVals As Boolean
  Dim initVars As CoCimSafeArray2

  Set initVars =
CreateObject("CIMPLICITY.CimSafeArray.2")

  Set oCimObj = CimGetObject
  Set oCimProcs = oCimObj.Procedures
  If oCimProcs.Count > 0 Then

    Set oCimProc =
oCimProcs.Item(0)

    If Not oCimProc Is Nothing
Then

      Set oCimProcActs =
oCimProc.Actions

      If oCimProcActs.Count
> 0 Then

        Set
oCimProcAct = oCimProcActs.Item(0)

        If
oCimProcAct.Type = gefActionOverlayScreen Then

          If
oCimProcAct.GetOverlayScreenEx2(strScrName, strProject,
_

              bSendPubVarVals,
initVars) = True Then

            MsgBox
"screen: " & strScrName _

              &
", project: " & strProject _

              &
", SendPubVarVals: " & bSendPubVarVals

            Dim
lb As Long

            Dim
ub As Long

            Dim
vals As String

            Dim
i As Long

            initVars.GetArrayBounds
2, lb, ub

            vals
= (ub - lb + 1) & " Initial Variable Values:"

            For
i = lb To ub

              vals
= vals & Chr(13) & " " & initVars.Element2(0, i)
_

                &
" ==> " & initVars.Element2(1, i)

            Next
i

            MsgBox
vals

          End
If

        End
If

      End If
    End If
  End If

End Sub