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

open all | close all

open all | close all

open all | close all

open all | close all

open all | close all

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

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

encode
char *dstr::encode(const void *data,unsigned int length,const char *symbols)

decode
void *dstr::decode(const char *bstr,const char *symbols)

main
int dstr::main(int argc,char **argv)

Motivation

Encodes data.

Signature:

char *dstr::encode(const void *data,unsigned int length,const char *symbols)

Parameters:

Type	Name	Direction	Description
const void *	data	[IN]	Pointer to the data that should be encoded.
unsigned int	length		The length (size) of the data pointed to by data.
const char *	symbols	[IN]	A null-terminated string containing the alphabet to use for encoding.

Return value:
The null-terminated string that contains the encoded data.

Decodes the string bstr and returns the decoded data.

Signature:

void *dstr::decode(const char *bstr,const char *symbols)

Parameters:

Type	Name	Direction	Description
const char *	bstr	[IN]	A null-terminated string of encoded data as returned by encode().
const char *	symbols	[IN]	A null-terminated string containing the alphabet to use for encoding.

Return value:
Returns a pointer to the new allocated memory block containing the decoded data.

Runs dstr as if it would be called from the command-line.

See Commandline-Interface.

Signature:

int dstr::main(int argc,char **argv)

Parameters:

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

Return value:
Exit status.