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

# gd\_fragmentname(3)

retrieve a Dirfile format specification fragment name

## NAME

gd\_fragmentname — retrieve a Dirfile format specification fragment name

## SYNOPSIS

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

**const char\* gd\_fragmentname(const DIRFILE \****dirfile***, int** *index***);**

## DESCRIPTION

The **gd\_fragmentname**() function queries a [dirfile(5)](/dirfile/5.md) database specified by *dirfile* and returns the filename of the format specification fragment indexed by the non-negative *index*.

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

The fragment with *index* equal to zero is always the primary fragment for the database (the file called  **format** in the root dirfile directory).  The largest valid value of *index* is one less than the total number of fragments, which may be obtained from a call to [**gd\_nfragments**(3)](/gd_nfragments/3.md).

## RETURN VALUE

Upon successful completion, **gd\_fragmentname**() returns a pointer to a read-only character string containing the file name of the specified fragment.

On error, this function returns NULL and stores a negative-valued error code in the **DIRFILE** object which may be retrieved by a subsequent call to [**gd\_error**(3)](/gd_error/3.md). Possible error codes are:\
  .TP 8 **GD\_E\_BAD\_DIRFILE** The supplied dirfile was invalid.\
  .TP 8 **GD\_E\_BAD\_INDEX** The supplied index was out of range.

A descriptive error string for the error may be obtained by calling [**gd\_error\_string**(3)](/gd_error_string/3.md).

## HISTORY

The **get\_fragmentname**() function appeared in GetData-0.4.0.

In GetData-0.7.0 this function was renamed to **gd\_fragmentname**().

## SEE ALSO

[dirfile(5)](/dirfile/5.md), [**gd\_error**(3)](/gd_error/3.md), [**gd\_error\_string**(3)](/gd_error_string/3.md), [**gd\_include**(3)](/gd_include/3.md), [**gd\_nfragments**(3)](/gd_nfragments/3.md), [**gd\_open**(3)](/gd_open/3.md), [**gd\_parent\_fragment**(3)](/gd_parent_fragment/3.md)
