NSPC_DELETE

Delete an entry within a symbol table

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

or

return = %NSPC_DELETE(id, access_code)

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 to reference. (n)

Discussion

The %NSPC_DELETE function deletes an entry from a symbol table.

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

When an entry is deleted from a symbol table, the access code and search index for other entries within the symbol table may change.

Examples

The following example deletes entry old_user from symbol table user_id.

xcall nspc_delete(user_id, old_user)