---
name: "File"
section: "3cc"
platform: "linux"
package: "libcommoncpp2-dev"
version: "1.0.13-5"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/File"
---

# File(3cc)

## NAME

File -

## SYNOPSIS

`#include <file.h>`

Inherited by **FIFOSession**, **fifostream**, and **RandomFile**.

### Public Types

typedef enum Error **Error**\
 typedef enum Access **Access**\
 enum **Error** { **errSuccess** =  0, **errNotOpened**, **errMmapFailed**, **errInitFailed**, **errOpenDenied**, **errOpenFailed**, **errOpenInUse**, **errReadInterrupted**, **errReadIncomplete**, **errReadFailure**, **errWriteInterrupted**, **errWriteIncomplete**, **errWriteFailure**, **errExtended** }\
 enum **Access** { **accessReadOnly** =  O\_RDONLY, **accessWriteOnly** =  O\_WRONLY, **accessReadWrite** =  O\_RDWR }\

### Protected Types

typedef **File::\_fcb** **fcb\_t**\
 typedef enum Open **Open**\
 typedef enum Attr **Attr**\
 typedef enum Complete **Complete**\
 typedef enum Mapping **Mapping**\
 enum **Open** { **openReadOnly** =  O\_RDONLY, **openWriteOnly** =  O\_WRONLY, **openReadWrite** =  O\_RDWR, **openAppend** =  O\_WRONLY \| O\_APPEND, **openSync** =  O\_RDWR, **openTruncate** =  O\_RDWR \| O\_TRUNC }\
 enum **Attr** { **attrInvalid** =  0, **attrPrivate** =   0400  \|  0200, **attrGroup** =  attrPrivate \|  0040  \|  0020, **attrPublic** =  attrGroup \|  0004  \|  0002 }\
 enum **Mapping** { **mappedRead** =  accessReadOnly, **mappedWrite** =  accessWriteOnly, **mappedReadWrite** =  accessReadWrite }\
 enum **Complete** { **completionImmediate**, **completionDelayed**, **completionDeferred** }\

## MEMBER TYPEDEF DOCUMENTATION

### typedef enum Access File::Access

### typedef enum Attr File::Attr` [protected]`

### typedef enum Complete File::Complete` [protected]`

### typedef enum Error File::Error

### typedef struct File::\_fcb File::fcb\_t` [protected]`

### typedef enum Mapping File::Mapping` [protected]`

### typedef enum Open File::Open` [protected]`

## MEMBER ENUMERATION DOCUMENTATION

### enum File::Access

**Enumeration values:**

- *accessReadOnly*

  - *accessWriteOnly*

  - *accessReadWrite*

  ### enum File::Attr` [protected]`

**Enumeration values:**

- *attrInvalid*

  - *attrPrivate*

  - *attrGroup*

  - *attrPublic*

  ### enum File::Complete` [protected]`

**Enumeration values:**

- *completionImmediate*

  - *completionDelayed*

  - *completionDeferred*

  ### enum File::Error

**Enumeration values:**

- *errSuccess*

  - *errNotOpened*

  - *errMmapFailed*

  - *errInitFailed*

  - *errOpenDenied*

  - *errOpenFailed*

  - *errOpenInUse*

  - *errReadInterrupted*

  - *errReadIncomplete*

  - *errReadFailure*

  - *errWriteInterrupted*

  - *errWriteIncomplete*

  - *errWriteFailure*

  - *errExtended*

  ### enum File::Mapping` [protected]`

**Enumeration values:**

- *mappedRead*

  - *mappedWrite*

  - *mappedReadWrite*

  ### enum File::Open` [protected]`

**Enumeration values:**

- *openReadOnly*

  - *openWriteOnly*

  - *openReadWrite*

  - *openAppend*

  - *openSync*

  - *openTruncate*

  ## AUTHOR

*Generated automatically by Doxygen for CommonC++ from the source code.*