next up previous contents
Next: miget_dimension_name/miset_dimension_name Up: DIMENSION FUNCTIONS (39) Previous: miset_dimension_cosines/miset_dimension_cosines   Contents

miget_dimension_description/miset_dimension_description

NAME

miget_dimension_description, miset_dimension_description - Get or set the dimension's description.

SYNOPSIS

#include <minc2.h>

int miget_dimension_description ( midimhandle_t dimension,
                                  char **comments_ptr);

int miset_dimension_description ( midimhandle_t dimension,
                                  const char *comments);

DESCRIPTION

Get and Set the dimension description. Note that the spatial dimensions
(xspace, yspace, zspace) are initialized according to minc1 description.
All other dimensions will have an empty description unless set by the user.

RETURN VALUE

Returns MI_NOERROR on success, or MI_ERROR on failure.



Robert VINCENT 2005-03-09