$Listimg Copy: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Copy a $list's image association</span> | <span class="pageSubtitle">Copy a $list's image association</span> | ||
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Listimg_Copy function is | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Listimg_Copy function is <var>[[CopyImageBinding (Stringlist subroutine)|CopyImageBinding]]</var>.</p> | ||
This function always returns a 0 indicating that the target $list is now associated with the same image as the source $list. | This function always returns a 0 indicating that the target $list is now associated with the same image as the source $list. | ||
| Line 15: | Line 15: | ||
<p class="syntax">[%RESULT =] $Listimg_Copy(target_list_id, source_list_id) | <p class="syntax">[%RESULT =] $Listimg_Copy(target_list_id, source_list_id) | ||
</p> | </p> | ||
<p>%result is always set to 0.</p> | |||
<p> | <p> | ||
If either the target or source $list identifier is missing or invalid, the request is cancelled. </p> | |||
<p>All errors cause request cancellation. | |||
<p | |||
</p> | </p> | ||
==Usage notes== | |||
<ul> | |||
<var>$Listimg_Copy</var> 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.< | <li><var>$Listimg_Copy</var> 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. | ||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 38: | Line 37: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Listimg_Copy]] | [[Category:$Functions|$Listimg_Copy]] | ||
Revision as of 21:18, 18 July 2013
Copy a $list's image association
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Listimg_Copy function is CopyImageBinding.
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.
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
[%RESULT =] $Listimg_Copy(target_list_id, source_list_id)
%result is always set to 0.
If either the target or source $list identifier is missing or invalid, the request is cancelled.
All errors cause request cancellation.
Usage notes
- $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.