$Listimg Copy: Difference between revisions
Jump to navigation
Jump to search
(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...") |
(Automatically generated page update) |
||
| (39 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Listimg_Copy}} | {{DISPLAYTITLE:$Listimg_Copy}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Copy a $list's image association</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $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. | ||
The $Listimg_Copy function accepts two arguments and returns a 0. It is a callable $function | The $Listimg_Copy function accepts two arguments and returns a 0. It is a [[Calling Sirius Mods $functions|callable]] $function. | ||
The first argument is the target $list identifier. This is a required argument. | 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. | The second argument is the source $list identifier. This is a required argument. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax" | <p class="syntax">[%RESULT =] $Listimg_Copy(target_list_id, source_list_id) | ||
</p> | </p> | ||
<p class=" | |||
<p | <p><var class="term">%result</var> 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 | <p>All errors cause request cancellation. | ||
</p> | </p> | ||
==Usage notes== | |||
<ul> | |||
<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}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Listimg_Copy]] | [[Category:$Functions|$Listimg_Copy]] | ||
Latest revision as of 22:51, 20 September 2018
Copy a $list's image association
Note: Many $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.