$Listimg Copy: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 41: Line 41:
   
   
</p>
</p>
<p class="caption">Products authorizing $Listimg_Copy
<p>
</p>
</p>




[[Category:$Functions|$Listimg_Copy]]
[[Category:$Functions|$Listimg_Copy]]

Revision as of 19:28, 25 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" />

$Listimg_Copy Function

%result is always set to 0.

All errors cause request cancellation

$ListImg Error Codes

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