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

Prokee Modules:

open all | close all

GUI Elements:

open all | close all

GUI Interactions:

open all | close all

GUI Layouts:

open all | close all

Games/Demos:

open all | close all

Third Party Libraries:

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

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Functions:

bmfragments_cleanup
int bmfragments_cleanup()

bmfragments_startup
int bmfragments_startup()

bmfragments_prepare_fragments

int bmfragments_prepare_fragments(const char *source_filename,const char *target_filename,int fragment_task_action,int baseman_copy_case)

bmfragments_handle_fragments
int bmfragments_handle_fragments(void *cc)

Motivation

Functions

bmfragments_cleanup

This function should be called when you do no longer need the module. The function frees resources allocated by startup(), prepare_fragments() and handle_fragments().

Signature:

int bmfragments_cleanup()

Return value:
Returns 0.

bmfragments_startup

This function performs some required initializations. Call this function before you start the copy process.

Signature:

int bmfragments_startup()

Return value:
Returns 0.

bmfragments_prepare_fragments

This loads source and target files into memory, to have them processed later by handle_fragments().

Call this function multiple times to load all involved files.

Call setup() before the first call of prepare_fragments().

Signature:

int bmfragments_prepare_fragments(const char *source_filename,const char *target_filename,int fragment_task_action,int baseman_copy_case)

Parameters:

Type	Name	Direction	Description
const char *	source_filename	[IN]	The file path to the file within the baseman 'base'.
const char *	target_filename	[IN]	The file path to the copied file in the workspace directory.
int	fragment_task_action		The method how to handle fragments within code files. Possible values are: #define FRAGMENTS_ACTION_DONOTHING 0 #define FRAGMENTS_ACTION_EXPORT 1 #define FRAGMENTS_ACTION_IMPORT 2 #define FRAGMENTS_ACTION_MERGE 3
int	baseman_copy_case		The number of the case assigned by baseman for this copy task. This value is currently ignored. It may be required for future versions of this function.

Return value:
Returns 0.

bmfragments_handle_fragments

This function updates the files loaded into memory by prepare_fragments() and writes changed files back to the disk.

Signature:

int bmfragments_handle_fragments(void *cc)

Parameters:

Type	Name	Direction	Description
void *	cc		This must be a void pointer to the CondCopyControl Instance created by Baseman. Do not provide your own implementation.

Return value:
Returns 0 on successful execution or a value other than 0 otherwise.