$Listimg Copy: Difference between revisions
(Created page with "{{DISPLAYTITLE:$Listimg_Copy}} <span class="pageSubtitle"><section begin="desc" />Copy a $list's image association<section end="desc" /></span> <p class="warning">Most Sirius $f...") |
m (1 revision) |
(No difference)
|
Revision as of 22:28, 8 February 2011
<section begin="desc" />Copy a $list's image association<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Listimg_Copy function is to be entered.
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 (:hdref refid=callfun.).
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" />
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.