ResetArgElements

Description

Clears the argument list.

Applies to

Window ActiveX controls

Syntax

activexcontrol.ResetArgElements ( )

Argument

Description

activexcontrol

Identifier for the instance of the PowerBuilder window ActiveX control. When used in HTML, this is the NAME attribute of the object element. When used in other environments, this references the control that contains the PowerBuilder window ActiveX.


Return value

Integer. Returns 1 if the function succeeds and -1 if an error occurs.

Usage

Call this function after calling InvokePBFunction or TriggerPBEvent to clear the argument list.

If you populate the argument list with SetArgElement, you should call this function to clear the argument list after using InvokePBFunction or TriggerPBEvent to call an event or function with arguments.

Examples

This JavaScript example calls the ResetArgElements function:

...
    retcd = PBRX1.TriggerPBEvent(theEvent, numargs);
    rc = parseInt(PBRX1.GetLastReturn());
    IF (rc != 1) {
    alert("Error. Empty string.");
    }
    PBRX1.ResetArgElements();
...

This VBScript example calls the ResetArgElements function:

...
    retcd = PBRX1.TriggerPBEvent(theEvent, numargs)
    rc = PBRX1.GetLastReturn()
    IF rc <> 1 THEN
    msgbox "Error. Empty string."
    END IF 
  PBRX1.ResetArgElements()
...

See also

GetLastReturn

InvokePBFunction

SetArgElement

TriggerPBEvent