\section{ost::File Class Reference}
\label{classost_1_1_file}\index{ost::File@{ost::File}}
{\tt \#include $<$file.h$>$}
Inheritance diagram for ost::File::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3cm]{classost_1_1_file}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef enum {\bf Error} {\bf Error}
\item
typedef enum {\bf Access} {\bf Access}
\item
typedef enum {\bf Open} {\bf Open}
\item
typedef enum {\bf Attr} {\bf Attr}
\item
typedef enum {\bf Complete} {\bf Complete}
\item
typedef enum {\bf Mapping} {\bf Mapping}
\item
enum {\bf Error} \{ \par
{\bf err\-Success} = 0,
{\bf err\-Not\-Opened},
{\bf err\-Map\-Failed},
{\bf err\-Init\-Failed},
\par
{\bf err\-Open\-Denied},
{\bf err\-Open\-Failed},
{\bf err\-Open\-In\-Use},
{\bf err\-Read\-Interrupted},
\par
{\bf err\-Read\-Incomplete},
{\bf err\-Read\-Failure},
{\bf err\-Write\-Interrupted},
{\bf err\-Write\-Incomplete},
\par
{\bf err\-Write\-Failure},
{\bf err\-Lock\-Failure},
{\bf err\-Extended}
\}
\item
enum {\bf Access} \{ {\bf access\-Read\-Only} = O\_\-RDONLY,
{\bf access\-Write\-Only} = O\_\-WRONLY,
{\bf access\-Read\-Write} = O\_\-RDWR
\}
\item
enum {\bf Open} \{ \par
{\bf open\-Read\-Only} = O\_\-RDONLY,
{\bf open\-Write\-Only} = O\_\-WRONLY,
{\bf open\-Read\-Write} = O\_\-RDWR,
{\bf open\-Append} = O\_\-WRONLY $|$ O\_\-APPEND,
\par
{\bf open\-Sync} = O\_\-RDWR,
{\bf open\-Truncate} = O\_\-RDWR $|$ O\_\-TRUNC
\}
\item
enum {\bf Attr} \{ {\bf attr\-Invalid} = 0,
{\bf attr\-Private} = 0400 $|$ 0200,
{\bf attr\-Group} = attr\-Private $|$ 0040 $|$ 0020,
{\bf attr\-Public} = attr\-Group $|$ 0004 $|$ 0002
\}
\item
enum {\bf Mapping} \{ {\bf mapped\-Read} = access\-Read\-Only,
{\bf mapped\-Write} = access\-Write\-Only,
{\bf mapped\-Read\-Write} = access\-Read\-Write
\}
\item
enum {\bf Complete} \{ {\bf completion\-Immediate},
{\bf completion\-Delayed},
{\bf completion\-Deferred}
\}
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item
static const char $\ast$ {\bf get\-Extension} (const char $\ast$path)
\item
static const char $\ast$ {\bf get\-Filename} (const char $\ast$path)
\item
static char $\ast$ {\bf get\-Filename} (const char $\ast$path, char $\ast$buffer, size\_\-t size=64)
\item
static char $\ast$ {\bf get\-Dirname} (const char $\ast$path, char $\ast$buffer, size\_\-t size=256)
\item
static char $\ast$ {\bf get\-Realpath} (const char $\ast$path, char $\ast$buffer, size\_\-t size=256)
\end{CompactItemize}
\subsection*{Protected Types}
\begin{CompactItemize}
\item
typedef {\bf ost::File::\_\-fcb} {\bf fcb\_\-t}
\end{CompactItemize}
\subsection*{Classes}
\begin{CompactItemize}
\item
struct {\bf \_\-fcb}
\end{CompactItemize}
\subsection{Member Typedef Documentation}
\index{ost::File@{ost::File}!Access@{Access}}
\index{Access@{Access}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef enum {\bf Access} {\bf ost::File::Access}}\label{classost_1_1_file_bb89129e6b212f038cfbf591a791a48e}
\index{ost::File@{ost::File}!Attr@{Attr}}
\index{Attr@{Attr}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef enum {\bf Attr} {\bf ost::File::Attr}}\label{classost_1_1_file_ec7dcd0857559c7b77fa1e5c7b8790be}
\index{ost::File@{ost::File}!Complete@{Complete}}
\index{Complete@{Complete}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef enum {\bf Complete} {\bf ost::File::Complete}}\label{classost_1_1_file_2afa7c4439dca397c91c687a2d7f7401}
\index{ost::File@{ost::File}!Error@{Error}}
\index{Error@{Error}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef enum {\bf Error} {\bf ost::File::Error}}\label{classost_1_1_file_c65e9af20a431154c8d8a811d4c58bde}
\index{ost::File@{ost::File}!fcb_t@{fcb\_\-t}}
\index{fcb_t@{fcb\_\-t}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf ost::File::\_\-fcb} {\bf ost::File::fcb\_\-t}\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_file_26a3ba9122edf9c1ce67dbff918a7302}
\index{ost::File@{ost::File}!Mapping@{Mapping}}
\index{Mapping@{Mapping}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef enum {\bf Mapping} {\bf ost::File::Mapping}}\label{classost_1_1_file_885985da266aee847c7ba6f85dddc17c}
\index{ost::File@{ost::File}!Open@{Open}}
\index{Open@{Open}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef enum {\bf Open} {\bf ost::File::Open}}\label{classost_1_1_file_4eedef07455f1487e2988d229ff8e2a7}
\subsection{Member Enumeration Documentation}
\index{ost::File@{ost::File}!Access@{Access}}
\index{Access@{Access}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf ost::File::Access}}\label{classost_1_1_file_f371cd81457b88328c08c4501f5e8271}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{accessReadOnly@{accessReadOnly}!ost::File@{ost::File}}\index{ost::File@{ost::File}!accessReadOnly@{accessReadOnly}}\item[{\em
access\-Read\-Only\label{classost_1_1_file_f371cd81457b88328c08c4501f5e8271cb2f610b0ba650697c1b68ae59c49a5d}
}]\index{accessWriteOnly@{accessWriteOnly}!ost::File@{ost::File}}\index{ost::File@{ost::File}!accessWriteOnly@{accessWriteOnly}}\item[{\em
access\-Write\-Only\label{classost_1_1_file_f371cd81457b88328c08c4501f5e827147fddcbc2462202862402f50dbd42459}
}]\index{accessReadWrite@{accessReadWrite}!ost::File@{ost::File}}\index{ost::File@{ost::File}!accessReadWrite@{accessReadWrite}}\item[{\em
access\-Read\-Write\label{classost_1_1_file_f371cd81457b88328c08c4501f5e8271e6776a9332be29f0ae3426d7f5d91a60}
}]\end{description}
\end{Desc}
\index{ost::File@{ost::File}!Attr@{Attr}}
\index{Attr@{Attr}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf ost::File::Attr}}\label{classost_1_1_file_e2d644ff1e3bff4611e73f5526081118}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{attrInvalid@{attrInvalid}!ost::File@{ost::File}}\index{ost::File@{ost::File}!attrInvalid@{attrInvalid}}\item[{\em
attr\-Invalid\label{classost_1_1_file_e2d644ff1e3bff4611e73f5526081118792916179434c95ed8e62da29e46749a}
}]\index{attrPrivate@{attrPrivate}!ost::File@{ost::File}}\index{ost::File@{ost::File}!attrPrivate@{attrPrivate}}\item[{\em
attr\-Private\label{classost_1_1_file_e2d644ff1e3bff4611e73f5526081118fb6d21af5bf0e8dfa64bbc4de94494ef}
}]\index{attrGroup@{attrGroup}!ost::File@{ost::File}}\index{ost::File@{ost::File}!attrGroup@{attrGroup}}\item[{\em
attr\-Group\label{classost_1_1_file_e2d644ff1e3bff4611e73f5526081118da5cbe9786424b3c652078c95d4ac5d3}
}]\index{attrPublic@{attrPublic}!ost::File@{ost::File}}\index{ost::File@{ost::File}!attrPublic@{attrPublic}}\item[{\em
attr\-Public\label{classost_1_1_file_e2d644ff1e3bff4611e73f5526081118572c71d829d969de792943d543067371}
}]\end{description}
\end{Desc}
\index{ost::File@{ost::File}!Complete@{Complete}}
\index{Complete@{Complete}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf ost::File::Complete}}\label{classost_1_1_file_81c533fbe84167e862768a396ff30e32}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{completionImmediate@{completionImmediate}!ost::File@{ost::File}}\index{ost::File@{ost::File}!completionImmediate@{completionImmediate}}\item[{\em
completion\-Immediate\label{classost_1_1_file_81c533fbe84167e862768a396ff30e321f7d50166d07b59cfa213e0a1686018f}
}]\index{completionDelayed@{completionDelayed}!ost::File@{ost::File}}\index{ost::File@{ost::File}!completionDelayed@{completionDelayed}}\item[{\em
completion\-Delayed\label{classost_1_1_file_81c533fbe84167e862768a396ff30e32f26018fa0614b8f02af5c87cdcf1299b}
}]\index{completionDeferred@{completionDeferred}!ost::File@{ost::File}}\index{ost::File@{ost::File}!completionDeferred@{completionDeferred}}\item[{\em
completion\-Deferred\label{classost_1_1_file_81c533fbe84167e862768a396ff30e320c2349e20e5133814955099a6408b9d8}
}]\end{description}
\end{Desc}
\index{ost::File@{ost::File}!Error@{Error}}
\index{Error@{Error}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf ost::File::Error}}\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{errSuccess@{errSuccess}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errSuccess@{errSuccess}}\item[{\em
err\-Success\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6207f3271e4132a03ed5624a6a5651c17}
}]\index{errNotOpened@{errNotOpened}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errNotOpened@{errNotOpened}}\item[{\em
err\-Not\-Opened\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6050d0e79c2ca5edf7f84c575e2957381}
}]\index{errMapFailed@{errMapFailed}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errMapFailed@{errMapFailed}}\item[{\em
err\-Map\-Failed\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6f8f7b5e5ffd0e724131dcb83efafd3d3}
}]\index{errInitFailed@{errInitFailed}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errInitFailed@{errInitFailed}}\item[{\em
err\-Init\-Failed\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6ee14627c63cab2530066a5a1b6421f71}
}]\index{errOpenDenied@{errOpenDenied}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errOpenDenied@{errOpenDenied}}\item[{\em
err\-Open\-Denied\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6a13e658bd29adfdbfccea54a74f212a7}
}]\index{errOpenFailed@{errOpenFailed}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errOpenFailed@{errOpenFailed}}\item[{\em
err\-Open\-Failed\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e640eaf2e7f3bdbb5aa380e183c35b253d}
}]\index{errOpenInUse@{errOpenInUse}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errOpenInUse@{errOpenInUse}}\item[{\em
err\-Open\-In\-Use\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6599eb6e10a9d34070a71ff55e5e05b86}
}]\index{errReadInterrupted@{errReadInterrupted}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errReadInterrupted@{errReadInterrupted}}\item[{\em
err\-Read\-Interrupted\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6797c9f9fb59f3f2d69a325c02c69d747}
}]\index{errReadIncomplete@{errReadIncomplete}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errReadIncomplete@{errReadIncomplete}}\item[{\em
err\-Read\-Incomplete\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6ab30228d37127f636e8296ef55ecccaf}
}]\index{errReadFailure@{errReadFailure}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errReadFailure@{errReadFailure}}\item[{\em
err\-Read\-Failure\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e64ad81d1cd9c7eda8ec6a655f3373bd98}
}]\index{errWriteInterrupted@{errWriteInterrupted}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errWriteInterrupted@{errWriteInterrupted}}\item[{\em
err\-Write\-Interrupted\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e61d1fde6a839bd8d41fd9b5ac98d86cb3}
}]\index{errWriteIncomplete@{errWriteIncomplete}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errWriteIncomplete@{errWriteIncomplete}}\item[{\em
err\-Write\-Incomplete\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6cdce746373598e52b2407bc020a3f8d1}
}]\index{errWriteFailure@{errWriteFailure}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errWriteFailure@{errWriteFailure}}\item[{\em
err\-Write\-Failure\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6cc1148cc886b1181e0471d634a644f5f}
}]\index{errLockFailure@{errLockFailure}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errLockFailure@{errLockFailure}}\item[{\em
err\-Lock\-Failure\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e6baa5f9bfe8d250ade4133bc81406b4fc}
}]\index{errExtended@{errExtended}!ost::File@{ost::File}}\index{ost::File@{ost::File}!errExtended@{errExtended}}\item[{\em
err\-Extended\label{classost_1_1_file_726c26bbd45c9cb0701267a2824284e69e9eef24fce1e9691b483fae652e5fc0}
}]\end{description}
\end{Desc}
\index{ost::File@{ost::File}!Mapping@{Mapping}}
\index{Mapping@{Mapping}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf ost::File::Mapping}}\label{classost_1_1_file_19532855f2541003a0a2240e1310b6a3}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{mappedRead@{mappedRead}!ost::File@{ost::File}}\index{ost::File@{ost::File}!mappedRead@{mappedRead}}\item[{\em
mapped\-Read\label{classost_1_1_file_19532855f2541003a0a2240e1310b6a32630a8cb91de2acc9e4e606bbd062a59}
}]\index{mappedWrite@{mappedWrite}!ost::File@{ost::File}}\index{ost::File@{ost::File}!mappedWrite@{mappedWrite}}\item[{\em
mapped\-Write\label{classost_1_1_file_19532855f2541003a0a2240e1310b6a338cb595821ce2e154fef758c44cdaec4}
}]\index{mappedReadWrite@{mappedReadWrite}!ost::File@{ost::File}}\index{ost::File@{ost::File}!mappedReadWrite@{mappedReadWrite}}\item[{\em
mapped\-Read\-Write\label{classost_1_1_file_19532855f2541003a0a2240e1310b6a37347e2b33a199b520bc98dc136e4231f}
}]\end{description}
\end{Desc}
\index{ost::File@{ost::File}!Open@{Open}}
\index{Open@{Open}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf ost::File::Open}}\label{classost_1_1_file_8b12e2068a433de7f63427b549d9772d}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{openReadOnly@{openReadOnly}!ost::File@{ost::File}}\index{ost::File@{ost::File}!openReadOnly@{openReadOnly}}\item[{\em
open\-Read\-Only\label{classost_1_1_file_8b12e2068a433de7f63427b549d9772d4c5bc3b0beded5891dcc40d2cb2b24f6}
}]\index{openWriteOnly@{openWriteOnly}!ost::File@{ost::File}}\index{ost::File@{ost::File}!openWriteOnly@{openWriteOnly}}\item[{\em
open\-Write\-Only\label{classost_1_1_file_8b12e2068a433de7f63427b549d9772dd682d89e71a5dd3ac438c9d981ca3112}
}]\index{openReadWrite@{openReadWrite}!ost::File@{ost::File}}\index{ost::File@{ost::File}!openReadWrite@{openReadWrite}}\item[{\em
open\-Read\-Write\label{classost_1_1_file_8b12e2068a433de7f63427b549d9772d4bf20ddd12a0cde912fd16662db49c49}
}]\index{openAppend@{openAppend}!ost::File@{ost::File}}\index{ost::File@{ost::File}!openAppend@{openAppend}}\item[{\em
open\-Append\label{classost_1_1_file_8b12e2068a433de7f63427b549d9772d18ac77d351475d57ef12fc35e3f5c2ae}
}]\index{openSync@{openSync}!ost::File@{ost::File}}\index{ost::File@{ost::File}!openSync@{openSync}}\item[{\em
open\-Sync\label{classost_1_1_file_8b12e2068a433de7f63427b549d9772dc7a180ce2eb4c708da93bc085ff83f9b}
}]\index{openTruncate@{openTruncate}!ost::File@{ost::File}}\index{ost::File@{ost::File}!openTruncate@{openTruncate}}\item[{\em
open\-Truncate\label{classost_1_1_file_8b12e2068a433de7f63427b549d9772d758de2e4063c9ae6306409c117809321}
}]\end{description}
\end{Desc}
\subsection{Member Function Documentation}
\index{ost::File@{ost::File}!getDirname@{getDirname}}
\index{getDirname@{getDirname}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static char$\ast$ ost::File::get\-Dirname (const char $\ast$ {\em path}, char $\ast$ {\em buffer}, size\_\-t {\em size} = {\tt 256})\hspace{0.3cm}{\tt [static]}}\label{classost_1_1_file_e3ac9d69ffbe1b30dc1bf4357f168271}
\index{ost::File@{ost::File}!getExtension@{getExtension}}
\index{getExtension@{getExtension}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static const char$\ast$ ost::File::get\-Extension (const char $\ast$ {\em path})\hspace{0.3cm}{\tt [static]}}\label{classost_1_1_file_6c9a8831142dd5060e2b431a81605b6d}
\index{ost::File@{ost::File}!getFilename@{getFilename}}
\index{getFilename@{getFilename}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static char$\ast$ ost::File::get\-Filename (const char $\ast$ {\em path}, char $\ast$ {\em buffer}, size\_\-t {\em size} = {\tt 64})\hspace{0.3cm}{\tt [static]}}\label{classost_1_1_file_4a7fcfba131d605a8190a640116b3bf4}
\index{ost::File@{ost::File}!getFilename@{getFilename}}
\index{getFilename@{getFilename}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static const char$\ast$ ost::File::get\-Filename (const char $\ast$ {\em path})\hspace{0.3cm}{\tt [static]}}\label{classost_1_1_file_6884f6587a477c318c9ac0c7a2d9320f}
\index{ost::File@{ost::File}!getRealpath@{getRealpath}}
\index{getRealpath@{getRealpath}!ost::File@{ost::File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static char$\ast$ ost::File::get\-Realpath (const char $\ast$ {\em path}, char $\ast$ {\em buffer}, size\_\-t {\em size} = {\tt 256})\hspace{0.3cm}{\tt [static]}}\label{classost_1_1_file_093e1edfe42e027f5d7b1f7ce05e24ce}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf file.h}\end{CompactItemize}
