%NSPC_STOA

Map search index to entry in symbol table

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
access_code = %NSPC_STOA(id, index)

Return value

access_code

One of the following values: (n)

[spacer]

If index is

%NSPC_STOA returns

Between 1 and the number of entries within the symbol table

The access code of the entry that corresponds to the search index

Less than 1

1

Greater than the number of entries within the symbol table

The number of entries

Arguments

id

The ID of the symbol table. (n)

index

The search index for an entry. (n)

Discussion

The %NSPC_STOA function retrieves the entry associated with a search index in a symbol table.

Note

The search index and access code for any given entry may change with every addition, deletion, or modification of the associated symbol table.

See also

%NSPC_ATOS for mapping an entry to a search index.

Examples

The following example retrieves the entry access code for search index srch.

user = %nspc_stoa(user_id, srch)