Package: File_Descriptor

## Documentation

Table of Contents
Class Inheritance Tree

## Index

Package: File_Descriptor

- Goto spec source

# Description

    package Alog.Facilities.File_Descriptor is

File_Descriptor facility. Used to log to a console or file. If no file is specified by a Set_Logfile()-call, console logging is used.

# Classes

### Instance

- Goto declaration in source
- Goto full declaration in source

    type Instance is new Alog.Facilities.Instance with private;

#### Ancestors:

Alog.Facilities.Instance

#### Primitive operations:

Alog.Facilities.Setup

- To API doc
- To spec

(Inherited)
Close_Logfile

- To API doc
- To spec

Get_Logfile

- To API doc
- To spec

Set_Logfile

- To API doc
- To spec

Teardown

- To API doc
- To spec

(overriding Alog.Facilities.Teardown)
Write (overriding Alog.Facilities.Write)
File Descriptor based logging facility.

# Types

### Handle

- Goto declaration in source

    type Handle is access all Instance;

# Constants & Global variables

### Open_File_Error

- Goto declaration in source

    Open_File_Error : exception;

This exception is raised if an error occurs while trying to open a logfile.

# Subprograms & Entries

### Teardown

- Goto spec in source

    procedure Teardown (Facility: in out Instance);

Implementation of Teardown-procedure.

### Set_Logfile

- Goto spec in source

    procedure Set_Logfile (Facility: in out Instance;Path:        String;Append:        Boolean := True);

Set logfile to use. If not set, standard output is used for logging. Set Append to False if an existing logfile should be overwritten.

### Get_Logfile

- Goto spec in source

    function Get_Logfile (Facility: Instance) return Ada.Text_IO.File_Access;

Get currently used logfile.

### Close_Logfile

- Goto spec in source

    procedure Close_Logfile (Facility: in out Instance;Remove:        Boolean := False);

Close opened logfile.