iDRS™ SDK 16
Loading...
Searching...
No Matches
CFileStream_interface.h
Go to the documentation of this file.
1
7#ifndef CFILESTREAM_INTERFACE_H
8
9#define CFILESTREAM_INTERFACE_H
10
12
13#include "idrs_common.h"
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
28CFileStream CFileStream_Create(const idrs_string strFileName, enum FileStreamMode const evFileStreamMode, idrs_exception *pargException);
29
38CFileStream CFileStream_Create2(const idrs_string strFileName, idrs_exception *pargException);
39
51void CFileStream_Open(CFileStream argCFileStream, const idrs_string strFileName, enum FileStreamMode const evFileStreamMode, idrs_exception *pargException);
52
63void CFileStream_Open2(CFileStream argCFileStream, const idrs_string strFileName, idrs_exception *pargException);
64
71enum FileStreamMode CFileStream_GetFileStreamMode(const CFileStream argCFileStream, idrs_exception *pargException);
72
83IDRS_UINT CFileStream_Read(CFileStream argCFileStream, IDRS_PVOID pvMem, IDRS_UINT const uiToRead, idrs_exception *pargException);
84
95IDRS_UINT CFileStream_Write(CFileStream argCFileStream, IDRS_CPVOID pvMem, IDRS_UINT const uiToWrite, idrs_exception *pargException);
96
104void CFileStream_Close(CFileStream argCFileStream, idrs_exception *pargException);
105
116IDRS_UINT64 CFileStream_Seek(CFileStream argCFileStream, IDRS_INT64 const iOffset, enum SeekPosition const evPos, idrs_exception *pargException);
117
126IDRS_BOOL CFileStream_IsOpen(const CFileStream argCFileStream, idrs_exception *pargException);
127
137IDRS_BOOL CFileStream_IsWriteOpen(const CFileStream argCFileStream, idrs_exception *pargException);
138
147IDRS_BOOL CFileStream_IsReadOpen(const CFileStream argCFileStream, idrs_exception *pargException);
148
156void CFileStream_Delete(const idrs_string strFileName, idrs_exception *pargException);
157
165void CFileStream_Destroy(CFileStream argCFileStream, idrs_exception *pargException);
166
167#ifdef __cplusplus
168}
169#endif /* __cplusplus */
170
171#endif /* CFILESTREAM_INTERFACE_H */
IDRS_BOOL CFileStream_IsReadOpen(const CFileStream argCFileStream, idrs_exception *pargException)
IsReadOpen tests if the file stream is opened in read mode.
enum FileStreamMode CFileStream_GetFileStreamMode(const CFileStream argCFileStream, idrs_exception *pargException)
GetFileStreamMode returns the open file mode.
CFileStream CFileStream_Create2(const idrs_string strFileName, idrs_exception *pargException)
Create creates a CFileStream object and opens the stream.
void CFileStream_Destroy(CFileStream argCFileStream, idrs_exception *pargException)
Destroys a CFileStream handle.
void CFileStream_Delete(const idrs_string strFileName, idrs_exception *pargException)
Deletes the file specified.
CFileStream CFileStream_Create(const idrs_string strFileName, enum FileStreamMode const evFileStreamMode, idrs_exception *pargException)
Create creates a CFileStream object and opens the stream.
void CFileStream_Open(CFileStream argCFileStream, const idrs_string strFileName, enum FileStreamMode const evFileStreamMode, idrs_exception *pargException)
Open opens a stream.
IDRS_UINT64 CFileStream_Seek(CFileStream argCFileStream, IDRS_INT64 const iOffset, enum SeekPosition const evPos, idrs_exception *pargException)
Seek changes the current position in the file stream.
void CFileStream_Close(CFileStream argCFileStream, idrs_exception *pargException)
Closes the current opened file.
void CFileStream_Open2(CFileStream argCFileStream, const idrs_string strFileName, idrs_exception *pargException)
Open opens a stream.
IDRS_UINT CFileStream_Write(CFileStream argCFileStream, IDRS_CPVOID pvMem, IDRS_UINT const uiToWrite, idrs_exception *pargException)
Write writes data in the stream at the current position.
IDRS_UINT CFileStream_Read(CFileStream argCFileStream, IDRS_PVOID pvMem, IDRS_UINT const uiToRead, idrs_exception *pargException)
Read reads data from the stream at the current stream position.
IDRS_BOOL CFileStream_IsOpen(const CFileStream argCFileStream, idrs_exception *pargException)
IsOpen tests if the file stream is opened in read or write mode.
IDRS_BOOL CFileStream_IsWriteOpen(const CFileStream argCFileStream, idrs_exception *pargException)
IsWriteOpen tests if the file stream is opened in write mode.
FileStreamMode
Filestream open modes.
Definition EnumDefinitions_interface.h:57
SeekPosition
Position to which offset is added when performing a Seek operation on a IByteStream.
Definition EnumDefinitions_interface.h:25
Interface for IByteStream wrapper.
Class CFileStream provides an IByteStream implementation for reading and writing data from files.
Class that handles a string of characters.
long long IDRS_INT64
An signed 64 bit value.
Definition idrsstd_interface.h:31
const void * IDRS_CPVOID
A constant void pointer.
Definition idrsstd_interface.h:51
IDRS_INT IDRS_BOOL
A Boolean value.
Definition idrsstd_interface.h:37
unsigned long long IDRS_UINT64
An unsigned 64 bit value.
Definition idrsstd_interface.h:33
void * IDRS_PVOID
A void pointer.
Definition idrsstd_interface.h:49
unsigned int IDRS_UINT
An unsigned integer.
Definition idrsstd_interface.h:27