This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:
  A
  B
  C
  D
  E
  F
  G
  I
  L
  M
  N
  O
  P
  R
  S
  T
  U
  W
     open all    |    close all

GUI Elements:
  B
  C
  I
  M
  P
  R
  S
  T
     open all    |    close all

GUI Interactions:
  B
  F
  H
  S
     open all    |    close all

GUI Layouts:
  L
     open all    |    close all

Games/Demos:
  M
     open all    |    close all

Third Party Libraries:
  P
  F
  Z
     open all    |    close all
Information about this Website / Informationen zu dieser Webseite:
In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module osfile [Version: v01]

This documentation describes the Prokee module interface.


Static Methods:
open (version 1)
FILE *osfile::open(const char *filename,const char *mode)
open (version 2)
FILE *osfile::open(const wchar_t *filename,const wchar_t *mode)
rm (version 1)
bool osfile::rm(const char *filename)
rm (version 2)
bool osfile::rm(const wchar_t *filename)
testfile (version 1)
bool osfile::testfile(const char *filename)
testfile (version 2)
bool osfile::testfile(const wchar_t *filename)
get_size (version 1)
unsigned long int osfile::get_size(const char *filename)
get_size (version 2)
unsigned long int osfile::get_size(const wchar_t *filename)
get_time_write (version 1)
time_t osfile::get_time_write(const char *filename)
get_time_write (version 2)
time_t osfile::get_time_write(const wchar_t *filename)

Motivation

Static Methods

   open (version 1)


Opens a file.

Signature:
FILE *osfile::open(const char *filename,const char *mode)

Parameters:
Type Name Direction Description
const char *filename[IN]The null-terminated file name.
const char *mode[IN]The file access mode.

Return value:
Returns a handle of the opened file, or NULL if the file could not be opened.

   open (version 2)


Opens a file.

Signature:
FILE *osfile::open(const wchar_t *filename,const wchar_t *mode)

Parameters:
Type Name Direction Description
const wchar_t *filename[IN]The null-terminated file name.
const wchar_t *mode[IN]The file access mode.

Return value:
Returns a handle of the opened file, or NULL if the file could not be opened.

   rm (version 1)


Removes a file.

Signature:
bool osfile::rm(const char *filename)

Parameters:
Type Name Direction Description
const char *filename[IN]The null-terminated file name.

Return value:
Returns true if the file could been removed, or false otherwise.

   rm (version 2)


Removes a file.

Signature:
bool osfile::rm(const wchar_t *filename)

Parameters:
Type Name Direction Description
const wchar_t *filename[IN]The null-terminated file name.

Return value:
Returns true if the file could been removed, or false otherwise.

   testfile (version 1)


Tests if a file exists.

Signature:
bool osfile::testfile(const char *filename)

Parameters:
Type Name Direction Description
const char *filename[IN]The null-terminated file name.

Return value:
Returns true if the file exists and false otherwise.

   testfile (version 2)


Tests if a file exists.

Signature:
bool osfile::testfile(const wchar_t *filename)

Parameters:
Type Name Direction Description
const wchar_t *filename[IN]The null-terminated file name.

Return value:
Returns true if the file exists and false otherwise.

   get_size (version 1)


Returns the size of the file.

Signature:
unsigned long int osfile::get_size(const char *filename)

Parameters:
Type Name Direction Description
const char *filename[IN]The null-terminated file name.

Return value:
The size of the files in bytes.

   get_size (version 2)


Returns the size of the file.

Signature:
unsigned long int osfile::get_size(const wchar_t *filename)

Parameters:
Type Name Direction Description
const wchar_t *filename[IN]The null-terminated file name.

Return value:
The size of the files in bytes.

   get_time_write (version 1)


Returns the time, the file has last been modified.

Signature:
time_t osfile::get_time_write(const char *filename)

Parameters:
Type Name Direction Description
const char *filename[IN]The null-terminated file name.

Return value:
Returns the time, the file has last been modified.

   get_time_write (version 2)


Returns the time, the file has last been modified.

Signature:
time_t osfile::get_time_write(const wchar_t *filename)

Parameters:
Type Name Direction Description
const wchar_t *filename[IN]The null-terminated file name.

Return value:
Returns the time, the file has last been modified.

Copyright © 2017 - 2019 by Andreas Pollhammer