%AX_TKGETINT

Get an ActiveX control property as an integer

value = %AX_TKGETINT(tk_container_id, property[, parameters])

Return value

value

On Windows, %AX_TKGETINT returns the current value for the property. On Unix a call to this routine will cause an error. On OpenVMS this routine always returns true. (^VAL)

Arguments

tk_container_id

The window ID for the ActiveX control’s Toolkit container. (n)

property

The name of the property to access. For information on supported properties, see Published properties for ActiveX Toolkit lists and Properties for ActiveX objects. (a)

parameters

(optional) Up to eight additional parameters required by a property. (n)

Discussion

%AX_TKGETINT enables you to retrieve an integer value for an ActiveX control. You can use this function only if you used %AX_TKSINGLE or %GRID_CREATE to create the container and load the control. Note the following:

If you used %AX_TKWIN to create the container, you’re limited to %AX_GETINT in the Synergy ActiveX API.
To retrieve an ActiveX control property with a non-integer value, use AX_TKGET.

If property does not reference a property whose value has an integer representation, value will be undefined.

Some controls support indexed properties, which are stored as arrays in a control and have one or more indices. If the property is an indexed property, parameters must be the index values of the array element to reference. The user documentation for a given control should specify when a property is indexed.

The parameters argument can pass only integer parameters. It cannot be used to pass additional parameters for a property that expects alpha parameters.

Rather than making multiple calls to AX_TKGETINT to get properties for the same control, use %AX_TKCTLID to get the ActiveX control ID, and then use AX_GETINT to get the properties. AX_TKGETINT is convenient (because you don’t need the control ID), but it calls AX_GETINT, so it’s not as efficient.