$Listimg Copy: Difference between revisions
m (1 revision) |
m (1 revision) |
||
Line 17: | Line 17: | ||
<p> | <p> | ||
</p> | </p> | ||
<p | <p>%result is always set to 0.</p> | ||
<p class="code"> | <p class="code"> | ||
All errors cause request cancellation | All errors cause request cancellation |
Revision as of 00:37, 26 October 2012
Copy a $list's image association
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Listimg_Copy function is the CopyImageBinding (Stringlist subroutine).
This function always returns a 0 indicating that the target $list is now associated with the same image as the source $list.
The $Listimg_Copy function accepts two arguments and returns a 0. It is a callable $function (see Calling Sirius Mods $functions).
The first argument is the target $list identifier. This is a required argument.
The second argument is the source $list identifier. This is a required argument.
Syntax
<section begin="syntax" />[%RESULT =] $Listimg_Copy(target_list_id, source_list_id) <section end="syntax" />
%result is always set to 0.
All errors cause request cancellation
If either the target or source $list identifier is missing or invalid, the request is cancelled.
$Listimg_Copy does not affect the contents of either the target or source $list; it simply changes the current image association of the target $list. If the source $list has no image association, $Listimg_Copy removes any image association from the target $list.
Products authorizing $Listimg_Copy
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility