%I_GETSTRING

Retrieve a string referenced by an input window data pointer

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
string = %I_GETSTRING(window_id, ctrl_pointer[, length])

Return value

string

The string referenced by the specified pointer, or a single space if ctrl_pointer is null. (a)

Arguments

window_id

The ID of the input window. (n)

ctrl_pointer

One of the following 16‑bit pointers, which are defined in the distributed fldinf.def and inpinf.def files: (i)

[spacer]

gs_hlpptr

Help identifier.

gs_fmtptr

Format.

gs_info

Information line.

gs_dfltptr

Default value or string.

gs_usrptr

User‑defined string.

gs_usrtyp

User‑defined data type.

gs_fldnam

Name of the field.

inp_setnam

Name of current input set.

inp_fldnam

Name of current input field.

inp_usertype

User‑defined data type.

inp_usertext

User text string.

length

(optional) The returned length of the string. (n)

Discussion

%I_GETSTRING enables you to retrieve the strings referenced by an input window’s internal pointers when you use the control argument in I_FLDINF.

The ctrl_pointer options from the gs_pts array in fldinf.def are valid after calling I_FLDINF to load the control structure. The ctrl_pointer options from inpinf.def are valid while within a method subroutine.

In the case of a null pointer, if passed, length will be returned as zero.

Ctrl_pointer is assumed to be valid if non‑null. Make sure that only pointers created during construction of the input window are used. An invalid pointer cannot be detected by this routine, and its use will have extremely unpredictable results.

You do not need to declare this function to use it. It is declared in tools.def.