Main Page   Modules   Data Structures   File List   Data Fields   Globals  

dar_user_interaction_struct Struct Reference
[User interaction]

Storage container for passing callback functions to the library. More...

#include <user_interaction.h>


Data Fields

dar_warning_callback warning
 Warning callback pointer.

dar_answer_callback answer
 Answer query callback pointer.

dar_string_callback string
 String query callback pointer.

dar_listing_callback listing
 Optional listing callback pointer.

bool verbose: 1
 If set verbose mode will be set when interaction struct is passed to function calls.

void * context
 An arbitrary value or object belonging to the library user.


Detailed Description

Storage container for passing callback functions to the library.

These are are function pointers, so the last optional callback (listing) can be set to NULL if unneeded, in which case listing data will be output using the warning callback.

All other callbacks are required.

Definition at line 249 of file user_interaction.h.


Field Documentation

void* dar_user_interaction_struct::context
 

An arbitrary value or object belonging to the library user.

Can be used to store configuration parameters or contextual data or objects. This pointer is passed as is to all callbacks.

Definition at line 275 of file user_interaction.h.


The documentation for this struct was generated from the following file: