Cpl::Io::File::Common_ Class Reference

This private concrete class is a helper class that implements the common functions for the handling files. More...

Detailed Description

This private concrete class is a helper class that implements the common functions for the handling files.

#include <Common_.h>

Static Public Member Functions
static Cpl::Io::Descriptor	open (const char *fileEntryName, bool readOnly=true, bool forceCreate=false, bool forceEmptyFile=false)
	Opens a file.
static bool	length (Cpl::Io::Descriptor fd, unsigned long &length)
	See Cpl::Io::File::ObjectApi.
static bool	currentPos (Cpl::Io::Descriptor fd, unsigned long &currentPos)
	See Cpl::Io::File::ObjectApi.
static bool	setRelativePos (Cpl::Io::Descriptor fd, long deltaOffset)
	See Cpl::Io::File::ObjectApi.
static bool	setAbsolutePos (Cpl::Io::Descriptor fd, unsigned long newoffset)
	See Cpl::Io::File::ObjectApi.
static bool	setToEof (Cpl::Io::Descriptor fd)
	See Cpl::Io::File::ObjectApi.

Member Function Documentation

currentPos()

static bool Cpl::Io::File::Common_::currentPos ( Cpl::Io::Descriptor  fd, unsigned long &  currentPos  )

static

See Cpl::Io::File::ObjectApi.

length()

static bool Cpl::Io::File::Common_::length ( Cpl::Io::Descriptor  fd, unsigned long &  length  )

static

See Cpl::Io::File::ObjectApi.

open()

static Cpl::Io::Descriptor Cpl::Io::File::Common_::open ( const char *  fileEntryName, bool  readOnly = true, bool  forceCreate = false, bool  forceEmptyFile = false  )

static

Opens a file.

The default arguments are set for:

o Read/Write access
o Do NOT create the file if the file does not exist
o Do NOT truncate the file contents

setAbsolutePos()

static bool Cpl::Io::File::Common_::setAbsolutePos ( Cpl::Io::Descriptor  fd, unsigned long  newoffset  )

static

See Cpl::Io::File::ObjectApi.

setRelativePos()

static bool Cpl::Io::File::Common_::setRelativePos ( Cpl::Io::Descriptor  fd, long  deltaOffset  )

static

See Cpl::Io::File::ObjectApi.

setToEof()

static bool Cpl::Io::File::Common_::setToEof ( Cpl::Io::Descriptor  fd )

static

See Cpl::Io::File::ObjectApi.

---

The documentation for this class was generated from the following file:

• Cpl/Io/File/Common_.h