gd_rename(3) GETDATA gd_rename(3)NAMEgd_rename — change the name of a dirfile field or alias
SYNOPSIS
#include <getdata.h>
int gd_rename(DIRFILE *dirfile, const char *old_code, const char
*new_name, unsigned int flags);
DESCRIPTION
The gd_rename() function changes the name of the field or alias speci‐
fied by old_code, which should not contain a representation suffix, de‐
fined in the dirfile specified by dirfile to new_name. If the new name
is the same as the old name, this function does nothing.
When renaming a metafield, the metafield should be specified in
old_code by its full (slashed) field code, while new_name should only
contain the new name (without slash).
The flags parameter should be zero or more of the following flags, bit‐
wise or'd together:
GD_REN_DATA
if old_code specifies a RAW field, the binary file associated
with the field will be renamed as well. Without this flag, no
changes are made to the binary file. If field_code specifies a
field of type other than RAW, this flag is ignored.
GD_REN_UPDB
Rename the field in any other field specifications which use
this field as an input (either as a vector input field to a de‐
rived field, or else as a scalar field parameter). Without this
flag, fields which depend on the old name of this field are left
unmodified.
RETURN VALUE
On success, gd_rename() returns zero. On error, -1 is returned and the
dirfile error is set to a non-zero error value. Possible error values
are:
GD_E_ACCMODE
The specified dirfile was opened read-only.
GD_E_ALLOC
The library was unable to allocate memory.
GD_E_BAD_CODE
The field specified by old_code was not found.
GD_E_BAD_DIRFILE
The supplied dirfile was invalid.
GD_E_BAD_FIELD_TYPE
An attempt was made to rename the immutable INDEX field.
GD_E_DUPLICATE
The new name specified is already in use by another entry.
GD_E_PROTECTED
The metadata of the format specification fragment containing
the entry was protected from change, or the binary data of the
fragments was protected from change and a binary file move was
requested.
GD_E_RAW_IO
An I/O error occurred while attempting to rename the binary
file.
GD_E_UNKNOWN_ENCODING
The encoding scheme of the specified field could not be deter‐
mined or was not understood by GetData.
GD_E_UNSUPPORTED
The encoding scheme of the field does not support binary file
renaming.
The dirfile error may be retrieved by calling gd_error(3). A descrip‐
tive error string for the last error encountered can be obtained from a
call to gd_error_string(3).
SEE ALSOgd_metaflush(3), gd_open(3), gd_error(3), gd_error_string(3),
dirfile(5), dirfile-format(5)Version 0.8.0 27 June 2012 gd_rename(3)
