DATAMANIP (ksegops) functions
LIBRARY ROUTINE
lkcptoval - copy data from specified segment into value segment
LIBRARY CALL
int
lkcptoval(
kobject source_object,
char *segment_name,
kobject destination_object)
INPUT
- source_object - object to copy the segment from
- segment_name - segment name for segment to copy
OUTPUT
- destination_object - object to put the segment into
RETURN VALUE
TRUE (1) on success, FALSE (0) otherwise
DESCRIPTION
This routine copies a segment from the source_object and
put it into the destination_object's value segment.
The higher dimensions will be rolled into the
elements dimension of the value segment. If the
dimension is less than 5, the data will be copied
into the lowest order dimension of the value segment
first, then the next, etc. and the higher dimensions
ignored. If the value segment exists in the source
object it will be replaced.
Only the size and data type attribute will be changed
in the value segment, all others will not be
transferred. If the value does not yet exist, then
the dimension and index order of the value segment
will be set to the defaults: 5 and width, height,
depth, time, and elements. If it does exist the
index order will not be changed.
ADDITIONAL INFORMATION
none
EXAMPLES
none
SIDE EFFECTS
none
RESTRICTIONS
Results guaranteed only if dimension of destination
segment is 5. Other dimensions are not tested and
may produce poor results.
MODIFICATION
none
FILES
$DATAMANIP/objects/library/ksegops/src/lkcptoval.c
SEE ALSO
ksegops(3)
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.