NSPC_GETDATA

Retrieve an entry’s data from a symbol table

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall NSPC_GETDATA(id, access_code, data[, entry_name])

or

return = %NSPC_GETDATA(id, access_code, data[, entry_name])

Return value

return

Always a value of 1. (n)

Arguments

id

The ID of the symbol table. (n)

access_code

The access code of the entry. (n)

data

The returned user‑defined data associated with the entry. (a)

entry_name

(optional) The returned name of the entry. (a)

Discussion

The %NSPC_GETDATA function retrieves the data for an entry within a symbol table.

If D_NSPC_CASE was not specified when the symbol table was created, the entry_name returned is all in one case, either upper or lower, depending on the search engine in the environment.

Data can be up to 100 characters in length, as defined in %NSPC_OPEN.

We recommend that you XCALL NSPC_GETDATA instead of accessing it as a function.

See also

NSPC_PUTDATA for modifying an entry’s data.

Examples

The following example gets the user‑defined data and name for entry user.

xcall nspc_getdata(user_id, user, user_data, username)