GefProcAction.GetRampSetpoint (method)

Retrieves the configuration information for the action.

Syntax:

Boolean = object.GetRampSetpoint ( PointID, Offset, AlternateOffset, AllowEdit )

Parameters:

PointID As BSTR* -

Offset As double* -

AlternateOffset As double* -

AllowEdit As VARIANT_BOOL* -

Description:

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

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

Example:

Sub GefProcAction_GetRampSetpoint()

Dim oCimObj As GefObject

    Dim oCimProcs As
GefProcedures

    Dim oCimProc As
GefProcedure

    Dim oCimProcActs As
GefProcActions

    Dim oCimProcAct As
GefProcAction

    Dim strPointId As String
    Dim nOffSet As Double
    Dim nAltOffSet As Double
    Dim bAllowEdit As Boolean

    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 = gefActionRampSetpoint Then

                    If
oCimProcAct.GetRampSetpoint(strPointId, nOffSet, nAltOffSet,
bAllowEdit) = True Then

                        MsgBox
"The point id is " & strPointId

                        MsgBox
"The off set is " & nOffSet

                        MsgBox
"The alternative offset is " & nAltOffSet

                        MsgBox
"Allow edit is " & bAllowEdit

                    End
If

                End
If

            End
If

        End
If

End If

End Sub