SetArgElement PowerScript function

Description

Sets the value in the specified argument element.

Controls

Window ActiveX controls

Syntax

<span>activexcontrol</span>.<span>SetArgElement</span> ( <span>index</span>, <span>argument</span> )

1	<span>activexcontrol</span>.<span>SetArgElement</span> ( <span>index</span>, <span>argument</span> )

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.
index	Integer specifying argument placement.
argument	Any specifying the argument value.

Return Values

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

Usage

Call this function before calling InvokePBFunction or TriggerPBEvent to
specify an argument for the passed function.

JavaScript scripts must use this function to specify function
and event arguments. VBScript scripts can either use this function
or specify the arguments array directly.

Examples

This JavaScript example calls the SetArgElement function:

function triggerEvent(f) {

1	function triggerEvent(f) {

        var retcd;

1	var retcd;

        var rc;

var rc;

        var numargs;

1	var numargs;

        var theEvent;

1	var theEvent;

        var theArg;

1	var theArg;

        retcd = 0;

1	retcd = 0;

        numargs = 1;

1	numargs = 1;

        theArg = f.textToPB.value;

1	theArg = f.textToPB.value;

        PBRX1.<span>SetArgElement</span>(1, theArg);

1	PBRX1.<span>SetArgElement</span>(1, theArg);

        theEvent = "ue_args";

1	theEvent = "ue_args";

        retcd = PBRX1.TriggerPBEvent(theEvent, numargs);

1	retcd = PBRX1.TriggerPBEvent(theEvent, numargs);

...

...

Connection Information

SetArgElement – PB Docs 125