---
name: "gd_aliases"
section: "3"
platform: "linux"
package: "libgetdata-doc"
version: "0.11.0-15"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/gd_aliases"
---

# gd\_aliases(3)

retrieve a list of aliases for a field in a Dirfile database

## NAME

gd\_aliases — retrieve a list of aliases for a field in a Dirfile database

## SYNOPSIS

**#include \<getdata.h\>**

**const char \*\*gd\_aliases(DIRFILE \****dirfile***, const char \****field\_code***);**

## DESCRIPTION

The **gd\_aliases**() function queries a [dirfile(5)](/dirfile/5.md) database specified by *dirfile* and returns a read-only list of aliases of the field specified by *field\_code*.

The *dirfile* argument must point to a valid DIRFILE object previously created by a call to [**gd\_open**(3)](/gd_open/3.md).

The array returned will be de-allocated by a call to [**gd\_close**(3)](/gd_close/3.md) and should not be de-allocated by the caller.  The list returned should not be assumed to be in any particular order.  The array is terminated by a NULL pointer.  The number of strings in the array can be obtained from a call to [**gd\_naliases**(3)](/gd_naliases/3.md).

The caller may not modify any strings in the array, or the array itself.  Doing so may cause database corruption.  The pointer returned is guaranteed to be valid until **gd\_aliases**() is called again with the same arguments, or until the array is de-allocated by a call to [**gd\_close**(3)](/gd_close/3.md).

## RETURN VALUE

Upon successful completion, **gd\_aliases**() returns a pointer to an array of strings containing the values of all the aliases for the specified field.  The array is terminated by a NULL pointer. If successful, this list will always contain at least one entry, to wit: *field\_code*.

On error it returns NULL and sets the dirfile error to a non-zero error value. Possible error values are:\
  .TP 8 **GD\_E\_ALLOC** The library was unable to allocate memory.\
  .TP 8 **GD\_E\_BAD\_CODE** The specified field code was not found in the database.\
  .TP 8 **GD\_E\_BAD\_DIRFILE** The supplied dirfile was invalid.

The dirfile error may be retrieved by calling [**gd\_error**(3)](/gd_error/3.md). A descriptive error string for the last error encountered can be obtained from a call to [**gd\_error\_string**(3)](/gd_error_string/3.md).

## HISTORY

The **gd\_aliases**() function appeared in GetData-0.8.0.

## SEE ALSO

[**gd\_open**(3)](/gd_open/3.md), [**gd\_alias\_target**(3)](/gd_alias_target/3.md), [**gd\_naliases**(3)](/gd_naliases/3.md), [dirfile(5)](/dirfile/5.md)