---
name: "dwarf_start_macro_file"
section: "3"
platform: "freebsd"
package: "base"
version: "16.0-CURRENT-20261027-61c70dc16a79"
release: "FreeBSD 16.0-CURRENT (2026-10-27)"
platforms: ["freebsd"]
url: "https://new.carta.tech/dwarf_start_macro_file"
---

# dwarf\_start\_macro\_file(3)

mark the start of a source file inclusion

## NAME

**dwarf\_start\_macro\_file** – mark the start of a source file inclusion

## LIBRARY

library “libdwarf”

## SYNOPSIS

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

*int*\

**dwarf\_start\_macro\_file**(*Dwarf\_P\_Debug dbg*, *Dwarf\_Unsigned lineno*, *Dwarf\_Unsigned fileindex*, *Dwarf\_Error \*err*);

## DESCRIPTION

Function **dwarf\_start\_macro\_file**() marks the start of a new source file inclusion.

Argument *dbg* should reference a DWARF producer instance allocated using [dwarf\_producer\_init(3)](/dwarf_producer_init/3.md) or [dwarf\_producer\_init\_b(3)](/dwarf_producer_init_b/3.md).

Argument *lineno* specifies the line number of the source line where the source file inclusion occurs. A value of zero is used to indicate the file for the compilation unit source itself.

Argument *fileindex* specifies the index of the source file that is being included. Valid source file indices are those returned by [dwarf\_add\_file\_decl(3)](/dwarf_add_file_decl/3.md).

If argument *err* is not NULL, it will be used to store error information in case of an error.

## RETURN VALUES

On success, function **dwarf\_start\_macro\_file**() returns DW\_DLV\_OK. In case of an error, function **dwarf\_start\_macro\_file**() returns DW\_DLV\_ERROR and sets the argument *err*.

## ERRORS

Function **dwarf\_start\_macro\_file**() can fail with:

- \[DW\_DLE\_ARGUMENT\]

  Argument *dbg* was NULL.

- \[DW\_DLE\_MEMORY\]

  An out of memory condition was encountered during the execution of the function.

## SEE ALSO

[dwarf(3)](/dwarf/3.md), [dwarf\_add\_file\_decl(3)](/dwarf_add_file_decl/3.md), [dwarf\_def\_macro(3)](/dwarf_def_macro/3.md), [dwarf\_end\_macro\_file(3)](/dwarf_end_macro_file/3.md), [dwarf\_producer\_init(3)](/dwarf_producer_init/3.md), [dwarf\_producer\_init\_b(3)](/dwarf_producer_init_b/3.md), [dwarf\_undef\_macro(3)](/dwarf_undef_macro/3.md), [dwarf\_vendor\_ext(3)](/dwarf_vendor_ext/3.md)