next up previous contents
Next: miget_dimension_offsets/miset_dimension_offsets Up: DIMENSION FUNCTIONS (39) Previous: miget_dimension_description/miset_dimension_description   Contents

miget_dimension_name/miset_dimension_name

NAME

miget_dimension_name, miset_dimension_name - get or set the identifier
of a MINC dimension

SYNOPSIS

#include <minc2.h>

int miget_dimension_name ( midimhandle_t dimension, char **name_ptr );
int miset_dimension_name ( midimhandle_t dimension, const char *name );

DESCRIPTION

miget_dimension_name retrieves the name of the given dimension, allocating
the space needed.  The memory allocated by this function should be released
with a call to mifree_name().

miset_dimension_name will rename an existing dimension.  The new name
must be no greater than 128 characters in length, including the
trailing zero byte.

RETURN VALUE

miget_dimension_name returns the length of the name retrieved, including
the terminating zero byte.  miset_dimension_name will return MI_NOERROR
on success.  Both functions return MI_ERROR if an error occurs.

SEE ALSO

mifree_name



Robert VINCENT 2005-03-09