M_USER

Retrieve a user text string for a menu entry

WTSupported in traditional Synergy on Windows

WNSupported in Synergy .NET on Windows

USupported on UNIX

VSupported on OpenVMS

xcall M_USER(entry, text) 

Arguments

entry

A menu entry name on a placed column. (a)

text

Returned with the text of the menu entry’s user-defined string. (a)

Discussion

M_USER retrieves the user-defined string for the first menu entry that matches the entry name specified by the USER qualifier of the .ENTRY command. The menu columns are searched from left to right.

Entry is not case sensitive. If entry isn’t found on any placed column or if it doesn’t have a user-defined string, text remains unchanged.

You cannot retrieve user-defined text for submenu entries. The only way to access user strings for submenu entries is by testing g_entusr (defined in tools.def), which contains the user string associated with the last primary menu or submenu entry selected. If the entry has no user text associated with it, g_entusr is blank.

The maximum size of text is 80 characters.

See also

.ENTRY script command for information about specifying user strings

Examples

The following example returns the user-defined text string for the menu entry “system” in privs. The user-defined text string could contain a security level that must be checked before the menu selection is processed.

xcall m_user("system", privs)