NSPC_RESET

Reset a symbol table

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall NSPC_RESET(id)

or

return = %NSPC_RESET(id)

Return value

return

Always a value of 1. (n)

Arguments

id

The ID of the symbol table. (n)

Discussion

The %NSPC_RESET function resets a symbol table to its initial state, using the arguments passed on the initial call to %NSPC_OPEN.

A symbol table should be reset when you want to release unused memory. When entries are deleted in a symbol table, resources are still allocated until the symbol table is reset or closed.

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

Examples

The following example initializes symbol table user_id.

xcall nspc_reset(user_id)