M_SCINFO

Get menu and shortcut entry information

WTSupported in traditional Synergy on Windows

WNSupported in Synergy .NET on Windows

USupported on UNIX

VSupported on OpenVMS

xcall M_SCINFO(function, shortcut, entry, [number][, text]) 

Arguments

function

Identifies which menu entries will be processed. (n)

D_ENTS

All entries. (default)

D_ENAB_ENTS

Enabled entries.

D_DSAB_ENTS

Disabled entries.

D_SCS

Entries with shortcuts.

D_ENAB_SCS

Enabled entries with shortcuts.

D_DSAB_SCS

Disabled entries with shortcuts.

D_SINGLE_ENT

A specific entry.

shortcut

An array returned with the shortcut text for the menu entries specified by function. (a)

entry

An array returned with the entry names of the menu entries specified by function. (a)

number

(optional) The maximum number of elements to load in the shortcut and entry arrays. It is returned with the number of items found. If not passed, defaults to 1. (n)

text

(optional) An array returned with the text of the entries specified by function. (a)

Discussion

M_SCINFO retrieves information about placed menu entries and their shortcuts and returns it in an array of entry names and an array of shortcut names.

If D_SINGLE_ENT is specified, the menu entry name for which to search must be passed as the first element in entry.

If text is passed, it is loaded with the corresponding menu text, minus the shortcut key names. The elements in shortcut, entry, and text will directly correspond with each other. Shortcut entries are blank if the corresponding menu entry does not have a shortcut defined.

Examples

The following example loads the shortcut text, entry names, and menu entry text for the first 98 enabled menu column entries. This information could be passed to a help routine to create a window that lists the available shortcuts.

count   ,i4 
scuts   ,98a5 
name    ,98a20 
text    ,98a30 
count=98 
xcall m_scinfo(D_ENAB_ENTS, scuts, name, count, text)