CimEvent.GetOleParm (function)

Obsolete

Replaced by a GefEventContext

Syntax

CimEvent.GetOleParm(parmIndex%)

CimEvent.GetOleParm(parmName$)

Description

Returns a Variant representing the value of a parameter from an ActiveX control event. This is only valid if the event type is CIM_ET_OLE_EVENT.

Comments

The parmIndex% parameter is an Integer specifying the index of the parameter as it was passed from the ActiveX control event.

The parmName$ parameter is a String specifying the name of the parameter as it was passed from the ActiveX control event. For example if the control fires the event MouseDown(xPos As Integer, yPos As Integer) then xPos will have the name xPos, and yPos will have the name yPos.

Example

Dim Ev As CimEvent

Dim Var As Variant

Set Ev = CimGetEvent()

If Ev.Type = CIM_ET_OLE_EVENT Then

  Count% = Ev.OleParmsCount

  Index% = 0

  While Index% < Count%

    Var = Ev.GetOleParm(Index%)

    'Do Stuff with the parameter.

    Index% = Index% + 1

  Wend

  x% = Ev.GetOleParm("xPos")

  y% = Ev.GetOleParm("yPos")

End If

More information

Obsolete basic extensions.