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 prompt [Version: v01]

This documentation describes the Prokee module interface.


Functions:
prompt_readFile
char *prompt_readFile(char **utf8_buffer,unsigned int *buffer_ln)

Static Methods:
main
int prompt::main(int argc,char **argv)

Motivation


Functions

   prompt_readFile


Reads characters from stdin until EOF is reached.

This function may read unicode characters on modern operating systems. Read characters are written utf8-encoded to *buffer. Each character may consume up to 4 bytes of space.

Signature:
char *prompt_readFile(char **utf8_buffer,unsigned int *buffer_ln)

Parameters:
Type Name Direction Description
char **utf8_buffer[OUT]The buffer where the read characters are stored. If the buffer is to small, the function will allocate a bigger buffer and store the size-1 of the new buffer in *buffer_ln.
unsigned int *buffer_ln[IN/OUT]The alocated size of the buffer in bytes. If more than *buffer_ln characters are read, than a larger buffer is allocated and *buffer_ln is set to the new size-1.

Return value:
Returns *buffer


Static Methods

   main


Runs prompt_readFile() and prints the input to stdout.

Signature:
int prompt::main(int argc,char **argv)

Parameters:
Type Name Direction Description
int argcThe number of command-line parameters.
char **argv[IN]The command-line parameters.

Return value:
Exit status. (EXIT_SUCCESS)


Copyright © 2017 - 2019 by Andreas Pollhammer