DATAMANIP (ksegops) functions
LIBRARY ROUTINE
lkcpfromval - copy data from value into specified segment
LIBRARY CALL
int
lkcpfromval(
kobject source_object,
char *segment_name,
int dimension,
int *index_order,
kobject destination_object)
INPUT
- source_object - object to copy the value segment from
- segment_name - segment name to copy to
- dimension - dimension of segment (not yet supported)
- index_order - index order of segment (not yet supported)
OUTPUT
- destination_object - object to put the segment into
RETURN VALUE
TRUE (1) on success, FALSE (0) otherwise
DESCRIPTION
This routine copies the five dimensional value segment
from the source_object to segment specified by
segment_name, of the destination_object. The data
will be copied into the lowest order dimension of the
destination segment, then the next order will be
used, and the next, and so forth, until all the
value data is copied. If the dimensionality of the
destination is less than five, then the last dimension
of the destination segment will have all the higher
order dimensions rolled into it.
If segment_name is one of the polymorphic segments
(KDMS_SEGMENT_VALUE, KDMS_SEGMENT_MASK,
KDMS_SEGMENT_MAP, * KDMS_SEGMENT_TIME or
KDMS_SEGMENT_LOCATION) than the * segment
dimensionalities and index orders specified by the
polymorphic model will be used. If the segment is not
one of the polymorphic segments, then the
dimensionality and index order of the destination
segment must be specified.
Only the size and data type attribute will be changed, all
others will not be transferred to the destination segment.
If the segment does not exist in the destination_object
and is not a polymorphic segment the dimension and
index order will be set. If it is a polymorphic segment
the default polymorphic dimension and index order will be
used.
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/lkcpfromval.c
SEE ALSO
ksegops(3)
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.