kaddr
kdms_get_data(
kobject object,
char *segment,
int *begin,
int *end,
kaddr data)
INPUT
object - the object from which the data will be obtained.
segment - the segment from which the data will be obtained.
begin - the begin marker of the region of data to
be retrieved.
end - the end marker of the region of data to be
retrieved.
data - a pointer to the region of
memory that will serve as a
destination for the data. If
this value is NULL, then
sufficient space for this
operation will be allocated
for this operation. The data
type kaddr is used because
it indicates a generic data
pointer.
OUTPUT
none
RETURN VALUE
If "data" is not initially NULL, then the data
space pointed to by "data" will be returned on
success. If the "data" argument is NULL, then
a new pointer to the requested data will be
returned. Unsuccessful calls to this routine
are indicated by a return value of NULL.
DESCRIPTION
kdms_get_data is used to obtain data that is stored
in a data object. The data that is retrieved is
designated by two "corner-markers". These are arrays
which contain N integer values, where N is the
dimensionality of the segment (the dimensionality of
a segment can be determined with the KDMS_DIMENSION
attribute). All values in begin argument must be
less than or equal to their corresponding value in
the end argument. In a two dimensional case, the
begin marker is the upper left corner and the end
marker is the lower right corner of a rectangle that
is obtained with this function call. The coordinate
origin is the upper, left, front corner of the data
set extended to N-space. The corner markers are
specified in the index order that the data set is
presented in.
ADDITIONAL INFORMATION
none
EXAMPLES
none
SIDE EFFECTS
none
RESTRICTIONS
This routine assumes that if the argument
"data" is not NULL, then it contains the
appropriate amount of memory with the
appropriate dimensionality for the
requested primitive.
MODIFICATION
none
FILES
$DATASERV/objects/library/kdataman/src/data.c
SEE ALSO
kdataman(3)
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.