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 prokee [Version: v01] (Interface Prokee)

   [abs_prokee]

Contents

Inheritance:
abs_prokee
Implementations: prokee

Constructors:
prokee (version 4)
abs_prokee *createprokee(char *_prokee_path,HINST hInstance,modman::AbsGraph *dllgraph)

Members:
current_prokee_license
int current_prokee_license;
hInstance
HINST hInstance;

Methods:
prokee_addclp
void prokee_addclp(int argc,char **argv)
Loading a library:
loadLibrary (version 1)
HINST loadLibrary(const char *dllFileName,int mode,HINST callerInst,int exe_license,int min_version,int max_version)
loadLibrary (version 2)
HINST loadLibrary(const char *dllFileName,int mode,HINST callerInst,int exe_license,int min_version,int max_version,const char *def_version)
addLibrary
bool addLibrary(HINST hInstDll,const char *dllFileName,int mode,HINST callerInst)
Adding functions:
addFunction
void addFunction(const char *dllFileName,const char *functionName,void *functionPointer)
Function pointers:
getFunctionPointer (version 1)
void *getFunctionPointer(const char *dllFileName,const char *functionName,HINST callerInst)
getFunctionPointer (version 2)
void *getFunctionPointer(HINST hInstDll,const char *functionName)
getSystemFunctionPointer
void *getSystemFunctionPointer(const char *dllFileName,const char *functionName,HINST callerInst)
getModuleFunctionPointer (version 1)
void *getModuleFunctionPointer(const char *moduleName,int mode,const char *functionName,HINST callerInst,int min_version,int max_version)
getModuleFunctionPointer (version 2)
void *getModuleFunctionPointer(const char *moduleName,int mode,const char *functionName,HINST callerInst,int min_version,int max_version,const char *def_version)
getProkeeFunctionPointer
void *getProkeeFunctionPointer(const char *functionName)
Searching modules:
findModule
HINST findModule(const char *property)
Configuring modules:
doConfigureModule
int doConfigureModule(const char *property)
Commandline arguments:
get_argc
int *get_argc()
get_argv
char **get_argv()
run_command_line
int run_command_line()
Prokee paths:
get_prokee_path
const char *get_prokee_path()
get_registry_path
char *get_registry_path(unsigned int extra_mem)
get_dll_path
char *get_dll_path(unsigned int extra_mem)

Constructors

   prokee (version 4)


Constructs the Prokee System.

When using this constructor, be sure to call prokee_addclp() afterwards.

The other constructors have been removed.

Constructor:
prokee(char *_prokee_path,HINST hInstance,modman::AbsGraph *dllgraph)

Factory Method:
abs_prokee *abs_prokeeInterface::createprokee(char *_prokee_path,HINST hInstance,modman::AbsGraph *dllgraph)

Wrapper Class:
prokeeWrapper(char *_prokee_path,HINST hInstance,modman::AbsGraph *dllgraph)

The static method abs_prokeeInterface::createprokee creates a new instance of class prokee.

Parameters:
Type Name Direction Description
char *_prokee_path[IN]The absolute path to the prokee system installation. E.g. /opt/prokee/ or C:/tools/opt/prokee/.
HINST hInstance[IN]Instance handle of the executable. This can also be set to 0.
modman::AbsGraph *dllgraph[IN]Pointer to an instance of modman::Graph (see module modeman).

Return value:
Returns a pointer to an instance of class prokee.

Members

   current_prokee_license


License of the current process.

Signature:
int current_prokee_license;

Setter- and getter-methods:
Use the methods get_current_prokee_license() and set_current_prokee_license(int) to get and set the value of this member variable.

   hInstance


Instance of the main executable.

Signature:
HINST hInstance;

Setter- and getter-methods:
Use the methods get_hInstance() and set_hInstance(HINST ) to get and set the value of this member variable.

Methods

   prokee_addclp


Adds the command line parameters to prokee.

Signature:
void prokee_addclp(int argc,char **argv)

Parameters:
Type Name Direction Description
int argcargc
char **argv[IN]argv


   loadLibrary (version 1)


Loads a library.

Signature:
HINST loadLibrary(const char *dllFileName,int mode,HINST callerInst,int exe_license,int min_version,int max_version)

Parameters:
Type Name Direction Description
const char *dllFileName[IN]Filename of the dll/so file to be loaded.
int modeThe run-mode of the library.
HINST callerInst[IN]Instance handle of the caller.
int exe_licenseThe license of the corrently runnung prokee process.
int min_versionThe lowest version of the required library.
int max_versionThe highest version of the required library.


Return value:
Instance handle of the loaded library. (or NULL in case of an error)

   loadLibrary (version 2)


Loads a library.

Signature:
HINST loadLibrary(const char *dllFileName,int mode,HINST callerInst,int exe_license,int min_version,int max_version,const char *def_version)

Parameters:
Type Name Direction Description
const char *dllFileName[IN]Filename of the dll/so file to be loaded.
int modeThe run-mode of the library.
HINST callerInst[IN]Instance handle of the caller.
int exe_licenseThe license of the corrently runnung prokee process.
int min_versionThe lowest version of the required library.
int max_versionThe highest version of the required library.
const char *def_versionThe default version of the required library.


Return value:
Instance handle of the loaded library. (or NULL in case of an error)

   addLibrary


Loads a library.

Signature:
bool addLibrary(HINST hInstDll,const char *dllFileName,int mode,HINST callerInst)

Parameters:
Type Name Direction Description
HINST hInstDll[IN]Instance handle of the library.
const char *dllFileName[IN]Filename of the dll/so file to be loaded.
int modeThe run-mode of the library.
HINST callerInst[IN]Instance handle of the caller.


   addFunction


Adds a function.

Signature:
void addFunction(const char *dllFileName,const char *functionName,void *functionPointer)

Parameters:
Type Name Direction Description
const char *dllFileName[IN]Filename of the dll/so file to be loaded.
const char *functionName[IN]The name of the function.
void *functionPointer[IN]Name of a required property.


   getFunctionPointer (version 1)


...

Signature:
void *getFunctionPointer(const char *dllFileName,const char *functionName,HINST callerInst)

Parameters:
Type Name Direction Description
const char *dllFileName[IN]Filename of the dll/so file to be loaded.
const char *functionName[IN]The name of the function.
HINST callerInst[IN]Instance handle of the caller.


Return value:
Pointer to function functionName or NULL.

   getFunctionPointer (version 2)


...

Signature:
void *getFunctionPointer(HINST hInstDll,const char *functionName)

Parameters:
Type Name Direction Description
HINST hInstDll[IN]Instance handle of the caller.
const char *functionName[IN]The name of the function.


Return value:
Pointer to function functionName or NULL.

   getSystemFunctionPointer


...

Signature:
void *getSystemFunctionPointer(const char *dllFileName,const char *functionName,HINST callerInst)

Parameters:
Type Name Direction Description
const char *dllFileName[IN]Filename of the dll/so file to be loaded.
const char *functionName[IN]The name of the function.
HINST callerInst[IN]Instance handle of the caller.


Return value:
Pointer to function functionName or NULL.

   getModuleFunctionPointer (version 1)


...

Signature:
void *getModuleFunctionPointer(const char *moduleName,int mode,const char *functionName,HINST callerInst,int min_version,int max_version)

Parameters:
Type Name Direction Description
const char *moduleName[IN]The name of the module. (This is not the path and also not the filename. Normally the name matches with the filename, but this is not to be expected in all cases.)
int modeThe run-mode of the library.
const char *functionName[IN]The name of the function.
HINST callerInst[IN]Instance handle of the caller.
int min_versionThe lowest version of the required library.
int max_versionThe highest version of the required library.


Return value:
Pointer to function functionName or NULL.

   getModuleFunctionPointer (version 2)


...

Signature:
void *getModuleFunctionPointer(const char *moduleName,int mode,const char *functionName,HINST callerInst,int min_version,int max_version,const char *def_version)

Parameters:
Type Name Direction Description
const char *moduleName[IN]The name of the module. (This is not the path and also not the filename. Normally the name matches with the filename, but this is not to be expected in all cases.)
int modeThe run-mode of the library.
const char *functionName[IN]The name of the function.
HINST callerInst[IN]Instance handle of the caller.
int min_versionThe lowest version of the required library.
int max_versionThe highest version of the required library.
const char *def_versionThe default version of the required library.


Return value:
Pointer to function functionName or NULL.

   getProkeeFunctionPointer


...

Signature:
void *getProkeeFunctionPointer(const char *functionName)

Parameters:
Type Name Direction Description
const char *functionName[IN]The name of the function.


Return value:
Pointer to function functionName or NULL.

   findModule


...

Signature:
HINST findModule(const char *property)

Parameters:
Type Name Direction Description
const char *property[IN]Name of a property.


Return value:
Instance handle of a loaded library (or NULL).

   doConfigureModule


...

Signature:
int doConfigureModule(const char *property)

Parameters:
Type Name Direction Description
const char *property[IN]Name of a property.


Return value:
...

   get_argc


...

Signature:
int *get_argc()

Return value:
Pointer to argc.

   get_argv


...

Signature:
char **get_argv()

Return value:
argv.

   run_command_line


Runs the command given by argc and argv from the command line.

Be sure to have the correct command line arguments set (by calling prokee_addclp()) before calling this function.

Signature:
int run_command_line()

Return value:
Commandline execution return value.

   get_prokee_path


Returns the path to the Prokee installation.

Signature:
const char *get_prokee_path()

Return value:
The Prokee system installation path.

   get_registry_path


Returns the Prokee registry path.

Signature:
char *get_registry_path(unsigned int extra_mem)

Parameters:
Type Name Direction Description
unsigned int extra_memNumber of extra bytes to allocate.


Return value:
Prokee registry path.

   get_dll_path


Returns the Prokee dlls path.

Signature:
char *get_dll_path(unsigned int extra_mem)

Parameters:
Type Name Direction Description
unsigned int extra_memNumber of extra bytes to allocate.


Return value:
Prokee dlls path.

Copyright © 2017 - 2019 by Andreas Pollhammer