$Listimg Copy: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Copy a $list's image association<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Copy a $list's image association<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Listimg_Copy function is [[ | <p class="warning">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)]].</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 callable $function (see [[Calling Sirius Mods $functions]]). | ||
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== | ||
| Line 24: | Line 23: | ||
<p class="caption">$ListImg Error Codes | <p class="caption">$ListImg Error Codes | ||
</p> | </p> | ||
If either the target or source $list identifier is missing or invalid, the request is cancelled. | If either the target or source $list identifier is missing or invalid, the request is cancelled. | ||
Revision as of 20:14, 10 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 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.
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $Listimg_Copy