MoveToId (Stringlist subroutine)

Move data from Stringlist to $list

This method moves data (Stringlist items) from a Stringlist to a $list. MoveToId is a subroutine that accepts one argument: the $list identifier of the $list to which data is to be moved. For more information about $list identifiers, see the Sirius Functions Reference Manual.

MoveToId is a member of the Stringlist class.

MoveToId Syntax

%sl:MoveToId(listid)

Syntax Terms

%sl

A Stringlist object.

listid

The $list identifier of the $list to which data is to be moved.

Usage Notes

• All errors in MoveToId result in request cancellation.
• After the MoveToId method is invoked, the method Stringlist is empty, though the object variable is still valid (non-null).
• MoveToId discards the original contents of the target $list.
• The MoveToId method copies to the target $list any image association that is set via BindImage.
• MoveToId simply moves the pointers to the Stringlist data to the target $list. It does not actually perform any data movement; therefore, it is extremely efficient.
• MoveToId is intended to facilitate the migration to the use of Stringlists of existing applications that use $lists. For example, suppose complex subroutine Summarize takes a $list identifier as its input parameter. Now, suppose some code that has a Stringlist in %list wants to pass the Stringlist to Summarize. The following code illustrates how this can be accomplished:

  %listid = $listnew
  %list:moveToId(%listId)
  call summarize(%listId)
  %list:moveFromId(%listId)
  return
  

  Stringlists should always be used in preference to $lists, so MoveToId is provided only for the migration of existing $list applications to the use of Stringlists.