<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>prelude-option</title> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> <link rel="start" href="index.html" title="Prelude library Reference Manual"> <link rel="up" href="ch04.html" title="Others"> <link rel="prev" href="libprelude-prelude-msg.html" title="prelude-msg"> <link rel="next" href="libprelude-prelude-connection.html" title="prelude-connection"> <meta name="generator" content="GTK-Doc V1.9 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> <link rel="part" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager"> <link rel="part" href="pt02.html" title="Part II. Sending events with libprelude"> <link rel="chapter" href="ch01.html" title="The low level IDMEF API"> <link rel="chapter" href="ch02.html" title="The high level IDMEF API"> <link rel="part" href="pt03.html" title="Part III. Reading events from the collector"> <link rel="part" href="pt04.html" title="Part IV. Filtering operation on IDMEF messages"> <link rel="chapter" href="ch03.html" title="Utility functions"> <link rel="chapter" href="ch04.html" title="Others"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> <tr valign="middle"> <td><a accesskey="p" href="libprelude-prelude-msg.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">Prelude library Reference Manual</th> <td><a accesskey="n" href="libprelude-prelude-connection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"><nobr><a href="#id389151" class="shortcut">Top</a>  |  <a href="#id423964" class="shortcut">Description</a></nobr></td></tr> </table> <div class="refentry" lang="en"> <a name="libprelude-prelude-option"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2> <a name="id389151"></a><span class="refentrytitle">prelude-option</span> </h2> <p>prelude-option</p> </td> <td valign="top" align="right"></td> </tr></table></div> <div class="refsynopsisdiv"> <h2>Synopsis</h2> <pre class="synopsis"> enum <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a>; enum <a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t">prelude_option_input_type_t</a>; typedef <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a>; typedef <a class="link" href="libprelude-prelude-option.html#prelude-option-context-t">prelude_option_context_t</a>; int (<a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t">*prelude_option_destroy_callback_t</a>) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *out, void *context); int (<a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t">*prelude_option_commit_callback_t</a>) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *out, void *context); int (<a class="link" href="libprelude-prelude-option.html#prelude-option-get-callback-t">*prelude_option_get_callback_t</a>) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *out, void *context); int (<a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t">*prelude_option_set_callback_t</a>) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *optarg, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *err, void *context); enum <a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t">prelude_option_argument_t</a>; enum <a class="link" href="libprelude-prelude-option.html#prelude-option-priority-t">prelude_option_priority_t</a>; enum <a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t">prelude_option_warning_t</a>; void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-priority">prelude_option_set_priority</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *option, <a class="link" href="libprelude-prelude-option.html#prelude-option-priority-t">prelude_option_priority_t</a> priority); void <a class="link" href="libprelude-prelude-option.html#prelude-option-print">prelude_option_print</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type, int descoff, FILE *fd); int <a class="link" href="libprelude-prelude-option.html#prelude-option-wide-send-msg">prelude_option_wide_send_msg</a> (<a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t">prelude_msgbuf_t</a> *msgbuf, void *context); void <a class="link" href="libprelude-prelude-option.html#prelude-option-destroy">prelude_option_destroy</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *option); int <a class="link" href="libprelude-prelude-option.html#prelude-option-read">prelude_option_read</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *option, const char **filename, int *argc, char **argv, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> **err, void *context); int <a class="link" href="libprelude-prelude-option.html#prelude-option-add">prelude_option_add</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *parent, <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> **retopt, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type, char shortopt, const char *longopt, const char *desc, <a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t">prelude_option_argument_t</a> has_arg, int (setprelude_option_t *opt, const char *optarg, prelude_string_t *err, void *context) (), int (getprelude_option_t *opt, prelude_string_t *out, void *context) ()); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-type">prelude_option_set_type</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type); <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-get-type">prelude_option_get_type</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-warnings">prelude_option_set_warnings</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t">prelude_option_warning_t</a> new_warnings, <a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t">prelude_option_warning_t</a> *old_warnings); char <a class="link" href="libprelude-prelude-option.html#prelude-option-get-shortname">prelude_option_get_shortname</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); const char* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-longname">prelude_option_get_longname</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-data">prelude_option_set_data</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, void *data); void* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-data">prelude_option_get_data</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); int <a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-commit">prelude_option_invoke_commit</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void *context); int <a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-set">prelude_option_invoke_set</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void **context); int <a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-get">prelude_option_invoke_get</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void *context); int <a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-destroy">prelude_option_invoke_destroy</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void *context); int <a class="link" href="libprelude-prelude-option.html#prelude-option-new-root">prelude_option_new_root</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> **retopt); int <a class="link" href="libprelude-prelude-option.html#prelude-option-new">prelude_option_new</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *parent, <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> **retopt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-longopt">prelude_option_set_longopt</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *longopt); const char* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-longopt">prelude_option_get_longopt</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-description">prelude_option_set_description</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *description); const char* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-description">prelude_option_get_description</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-has-arg">prelude_option_set_has_arg</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t">prelude_option_argument_t</a> has_arg); <a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t">prelude_option_argument_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-get-has-arg">prelude_option_get_has_arg</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-value">prelude_option_set_value</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *value); const char* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-value">prelude_option_get_value</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-help">prelude_option_set_help</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *help); const char* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-help">prelude_option_get_help</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-input-validation-regex">prelude_option_set_input_validation_regex</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *regex); const char* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-input-validation-regex">prelude_option_get_input_validation_regex</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-input-type">prelude_option_set_input_type</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t">prelude_option_input_type_t</a> input_type); <a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t">prelude_option_input_type_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-get-input-type">prelude_option_get_input_type</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); <a class="link" href="libprelude-prelude-list.html#prelude-list-t">prelude_list_t</a>* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-optlist">prelude_option_get_optlist</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a>* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-next">prelude_option_get_next</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *start, <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *cur); <a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t">prelude_bool_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-has-optlist">prelude_option_has_optlist</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a>* <a class="link" href="libprelude-prelude-option.html#prelude-option-get-parent">prelude_option_get_parent</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-destroy-callback">prelude_option_set_destroy_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t">prelude_option_destroy_callback_t</a> destroy); <a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t">prelude_option_destroy_callback_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-get-destroy-callback">prelude_option_get_destroy_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-set-callback">prelude_option_set_set_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t">prelude_option_set_callback_t</a> set); <a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t">prelude_option_set_callback_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-get-set-callback">prelude_option_get_set_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-get-callback">prelude_option_set_get_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, int (getprelude_option_t *opt, prelude_string_t *out, void *context) ()); <a class="link" href="libprelude-prelude-option.html#prelude-option-get-callback-t">prelude_option_get_callback_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-get-get-callback">prelude_option_get_get_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-commit-callback">prelude_option_set_commit_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t">prelude_option_commit_callback_t</a> commit); <a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t">prelude_option_commit_callback_t</a> <a class="link" href="libprelude-prelude-option.html#prelude-option-get-commit-callback">prelude_option_get_commit_callback</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt); void <a class="link" href="libprelude-prelude-option.html#prelude-option-set-default-context">prelude_option_set_default_context</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, void *context); int <a class="link" href="libprelude-prelude-option.html#prelude-option-new-context">prelude_option_new_context</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-context-t">prelude_option_context_t</a> **ctx, const char *name, void *data); void <a class="link" href="libprelude-prelude-option.html#prelude-option-context-destroy">prelude_option_context_destroy</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-context-t">prelude_option_context_t</a> *oc); <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a>* <a class="link" href="libprelude-prelude-option.html#prelude-option-search">prelude_option_search</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *parent, const char *name, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type, <a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t">prelude_bool_t</a> walk_children); <a class="link" href="libprelude-prelude-option.html#prelude-option-context-t">prelude_option_context_t</a>* <a class="link" href="libprelude-prelude-option.html#prelude-option-search-context">prelude_option_search_context</a> (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *name); </pre> </div> <div class="refsect1" lang="en"> <a name="id423964"></a><h2>Description</h2> <p> </p> </div> <div class="refsect1" lang="en"> <a name="id423980"></a><h2>Details</h2> <div class="refsect2" lang="en"> <a name="id423990"></a><h3> <a name="prelude-option-type-t"></a>enum prelude_option_type_t</h3> <a class="indexterm" name="id424002"></a><pre class="programlisting">typedef enum { PRELUDE_OPTION_TYPE_CLI = 0x01, PRELUDE_OPTION_TYPE_CFG = 0x02, PRELUDE_OPTION_TYPE_WIDE = 0x04, PRELUDE_OPTION_TYPE_CONTEXT = 0x08, PRELUDE_OPTION_TYPE_ROOT = 0x10, PRELUDE_OPTION_TYPE_DESTROY = 0x20 } prelude_option_type_t; </pre> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="id424020"></a><h3> <a name="prelude-option-input-type-t"></a>enum prelude_option_input_type_t</h3> <a class="indexterm" name="id424032"></a><pre class="programlisting">typedef enum { PRELUDE_OPTION_INPUT_TYPE_STRING = 1, PRELUDE_OPTION_INPUT_TYPE_INTEGER = 2, PRELUDE_OPTION_INPUT_TYPE_BOOLEAN = 3 } prelude_option_input_type_t; </pre> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="id424050"></a><h3> <a name="prelude-option-t"></a>prelude_option_t</h3> <a class="indexterm" name="id424062"></a><pre class="programlisting">typedef struct prelude_option prelude_option_t; </pre> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="id426288"></a><h3> <a name="prelude-option-context-t"></a>prelude_option_context_t</h3> <a class="indexterm" name="id426301"></a><pre class="programlisting">typedef struct prelude_option_context prelude_option_context_t; </pre> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="id426317"></a><h3> <a name="prelude-option-destroy-callback-t"></a>prelude_option_destroy_callback_t ()</h3> <a class="indexterm" name="id426329"></a><pre class="programlisting">int (*prelude_option_destroy_callback_t) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *out, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id426427"></a><h3> <a name="prelude-option-commit-callback-t"></a>prelude_option_commit_callback_t ()</h3> <a class="indexterm" name="id426440"></a><pre class="programlisting">int (*prelude_option_commit_callback_t) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *out, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id426537"></a><h3> <a name="prelude-option-get-callback-t"></a>prelude_option_get_callback_t ()</h3> <a class="indexterm" name="id444684"></a><pre class="programlisting">int (*prelude_option_get_callback_t) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *out, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id444780"></a><h3> <a name="prelude-option-set-callback-t"></a>prelude_option_set_callback_t ()</h3> <a class="indexterm" name="id444792"></a><pre class="programlisting">int (*prelude_option_set_callback_t) (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *optarg, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *err, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>optarg</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id444910"></a><h3> <a name="prelude-option-argument-t"></a>enum prelude_option_argument_t</h3> <a class="indexterm" name="id444922"></a><pre class="programlisting">typedef enum { PRELUDE_OPTION_ARGUMENT_REQUIRED = 1, PRELUDE_OPTION_ARGUMENT_OPTIONAL = 2, PRELUDE_OPTION_ARGUMENT_NONE = 3 } prelude_option_argument_t; </pre> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="id450470"></a><h3> <a name="prelude-option-priority-t"></a>enum prelude_option_priority_t</h3> <a class="indexterm" name="id450481"></a><pre class="programlisting">typedef enum { PRELUDE_OPTION_PRIORITY_IMMEDIATE = -2, PRELUDE_OPTION_PRIORITY_FIRST = -1, PRELUDE_OPTION_PRIORITY_NONE = 0, PRELUDE_OPTION_PRIORITY_LAST = 2 } prelude_option_priority_t; </pre> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="id450499"></a><h3> <a name="prelude-option-warning-t"></a>enum prelude_option_warning_t</h3> <a class="indexterm" name="id450511"></a><pre class="programlisting">typedef enum { PRELUDE_OPTION_WARNING_OPTION = 0x1, PRELUDE_OPTION_WARNING_ARG = 0x2 } prelude_option_warning_t; </pre> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="id450528"></a><h3> <a name="prelude-option-set-priority"></a>prelude_option_set_priority ()</h3> <a class="indexterm" name="id450540"></a><pre class="programlisting">void prelude_option_set_priority (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *option, <a class="link" href="libprelude-prelude-option.html#prelude-option-priority-t">prelude_option_priority_t</a> priority);</pre> <p> <a class="link" href="libprelude-prelude-option.html#prelude-option-set-priority"><code class="function">prelude_option_set_priority()</code></a> can be used to associate a priority with an option. This can be used to solve dependancies problem within differents options. </p> <p> A priority of -1 mean an option will always be executed last (with all other option with a -1 priority). </p> <p> The default priority for an option is 0, the caller is responssible for the way it assign priority (knowing that highest priority are always executed first).</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td> <td> Pointer on an option object. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td> <td> Priority of the option object. </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id450630"></a><h3> <a name="prelude-option-print"></a>prelude_option_print ()</h3> <a class="indexterm" name="id450642"></a><pre class="programlisting">void prelude_option_print (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type, int descoff, FILE *fd);</pre> <p> Dump option available in <em class="parameter"><code>opt</code></em> and hooked to the given types. If <em class="parameter"><code>opt</code></em> is NULL, then the root of the option list is used.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> Option(s) to print out. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> <td> Only option with specified types will be printed. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>descoff</code></em> :</span></p></td> <td> offset from the begining of the line where the description should start. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td> <td> File descriptor where the option should be dumped. </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id413503"></a><h3> <a name="prelude-option-wide-send-msg"></a>prelude_option_wide_send_msg ()</h3> <a class="indexterm" name="id413515"></a><pre class="programlisting">int prelude_option_wide_send_msg (<a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t">prelude_msgbuf_t</a> *msgbuf, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>msgbuf</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id413591"></a><h3> <a name="prelude-option-destroy"></a>prelude_option_destroy ()</h3> <a class="indexterm" name="id413604"></a><pre class="programlisting">void prelude_option_destroy (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *option);</pre> <p> Destroy a <a class="link" href="libprelude-prelude-option.html#prelude-option-t"><span class="type">prelude_option_t</span></a> object and all data associated with it (including all suboption).</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td> <td> Pointer on an option object. </td> </tr></tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id413660"></a><h3> <a name="prelude-option-read"></a>prelude_option_read ()</h3> <a class="indexterm" name="id413672"></a><pre class="programlisting">int prelude_option_read (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *option, const char **filename, int *argc, char **argv, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> **err, void *context);</pre> <p> <a class="link" href="libprelude-prelude-option.html#prelude-option-read"><code class="function">prelude_option_read()</code></a>, parse the given argument and try to match them against option in <em class="parameter"><code>option</code></em>. If an option match, it's associated callback function is called with the eventual option argument if any. </p> <p> Option not matched on the command line are searched in the configuration file specified by <em class="parameter"><code>filename</code></em>. </p> <p> if <em class="parameter"><code>option</code></em> is NULL, all system option will be matched against argc, and argv.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td> <td> A pointer on an option (list). </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td> <td> Pointer to the config filename. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td> <td> Number of argument. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td> <td> Argument list. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> <td> Pointer to a <a class="link" href="libprelude-prelude-string.html#prelude-string-t"><span class="type">prelude_string_t</span></a> object where to store an error string. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> The index of the first unhandled parameter if option parsing succeeded, or a negative value if an error occured. </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id458422"></a><h3> <a name="prelude-option-add"></a>prelude_option_add ()</h3> <a class="indexterm" name="id458434"></a><pre class="programlisting">int prelude_option_add (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *parent, <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> **retopt, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type, char shortopt, const char *longopt, const char *desc, <a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t">prelude_option_argument_t</a> has_arg, int (setprelude_option_t *opt, const char *optarg, prelude_string_t *err, void *context) (), int (getprelude_option_t *opt, prelude_string_t *out, void *context) ());</pre> <p> <a class="link" href="libprelude-prelude-option.html#prelude-option-add"><code class="function">prelude_option_add()</code></a> create a new option. The option is set to be the child of <em class="parameter"><code>parent</code></em>, unless it is NULL. In this case the option is a root option. </p> <p> The <em class="parameter"><code>type</code></em> parameters can be set to PRELUDE_OPTION_TYPE_CLI (telling the option may be searched on the command line), PRELUDE_OPTION_TYPE_CFG (telling the option may be searched in the configuration file) or both.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td> <td> Pointer on a parent option. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>retopt</code></em> :</span></p></td> <td> Pointer where to store the created option. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> <td> bitfields. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>shortopt</code></em> :</span></p></td> <td> Short option name. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>longopt</code></em> :</span></p></td> <td> Long option name. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>desc</code></em> :</span></p></td> <td> Description of the option. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>has_arg</code></em> :</span></p></td> <td> Define if the option has argument. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td> <td> Callback to be called when the value for this option change. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>get</code></em> :</span></p></td> <td> Callback to be called to get the value for this option. </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> Pointer on the option object, or NULL if an error occured. </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id467965"></a><h3> <a name="prelude-option-set-type"></a>prelude_option_set_type ()</h3> <a class="indexterm" name="id467977"></a><pre class="programlisting">void prelude_option_set_type (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id468043"></a><h3> <a name="prelude-option-get-type"></a>prelude_option_get_type ()</h3> <a class="indexterm" name="id468055"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> prelude_option_get_type (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id461478"></a><h3> <a name="prelude-option-set-warnings"></a>prelude_option_set_warnings ()</h3> <a class="indexterm" name="id461491"></a><pre class="programlisting">void prelude_option_set_warnings (<a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t">prelude_option_warning_t</a> new_warnings, <a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t">prelude_option_warning_t</a> *old_warnings);</pre> <p> Set current warnings flags to <em class="parameter"><code>new_warnings</code></em>. </p> <p> Uppon return, if not NULL, the pointer to <em class="parameter"><code>old_warnings</code></em> is updated to contain the old warnings.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>new_warnings</code></em> :</span></p></td> <td> bitwise OR of <a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t"><span class="type">prelude_option_warning_t</span></a>. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>old_warnings</code></em> :</span></p></td> <td> Pointer where to store the old <a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t"><span class="type">prelude_option_warning_t</span></a> to. </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id461591"></a><h3> <a name="prelude-option-get-shortname"></a>prelude_option_get_shortname ()</h3> <a class="indexterm" name="id461603"></a><pre class="programlisting">char prelude_option_get_shortname (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id461659"></a><h3> <a name="prelude-option-get-longname"></a>prelude_option_get_longname ()</h3> <a class="indexterm" name="id461671"></a><pre class="programlisting">const char* prelude_option_get_longname (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id473927"></a><h3> <a name="prelude-option-set-data"></a>prelude_option_set_data ()</h3> <a class="indexterm" name="id473939"></a><pre class="programlisting">void prelude_option_set_data (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, void *data);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id474005"></a><h3> <a name="prelude-option-get-data"></a>prelude_option_get_data ()</h3> <a class="indexterm" name="id474017"></a><pre class="programlisting">void* prelude_option_get_data (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id474072"></a><h3> <a name="prelude-option-invoke-commit"></a>prelude_option_invoke_commit ()</h3> <a class="indexterm" name="id474085"></a><pre class="programlisting">int prelude_option_invoke_commit (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ctname</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id433619"></a><h3> <a name="prelude-option-invoke-set"></a>prelude_option_invoke_set ()</h3> <a class="indexterm" name="id433631"></a><pre class="programlisting">int prelude_option_invoke_set (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void **context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ctname</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id433749"></a><h3> <a name="prelude-option-invoke-get"></a>prelude_option_invoke_get ()</h3> <a class="indexterm" name="id433761"></a><pre class="programlisting">int prelude_option_invoke_get (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ctname</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id468914"></a><h3> <a name="prelude-option-invoke-destroy"></a>prelude_option_invoke_destroy ()</h3> <a class="indexterm" name="id468926"></a><pre class="programlisting">int prelude_option_invoke_destroy (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *ctname, <a class="link" href="libprelude-prelude-string.html#prelude-string-t">prelude_string_t</a> *value, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ctname</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id469044"></a><h3> <a name="prelude-option-new-root"></a>prelude_option_new_root ()</h3> <a class="indexterm" name="id469056"></a><pre class="programlisting">int prelude_option_new_root (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> **retopt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>retopt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id469111"></a><h3> <a name="prelude-option-new"></a>prelude_option_new ()</h3> <a class="indexterm" name="id424925"></a><pre class="programlisting">int prelude_option_new (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *parent, <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> **retopt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>retopt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id425001"></a><h3> <a name="prelude-option-set-longopt"></a>prelude_option_set_longopt ()</h3> <a class="indexterm" name="id425013"></a><pre class="programlisting">void prelude_option_set_longopt (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *longopt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>longopt</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id425079"></a><h3> <a name="prelude-option-get-longopt"></a>prelude_option_get_longopt ()</h3> <a class="indexterm" name="id425091"></a><pre class="programlisting">const char* prelude_option_get_longopt (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id425148"></a><h3> <a name="prelude-option-set-description"></a>prelude_option_set_description ()</h3> <a class="indexterm" name="id425161"></a><pre class="programlisting">void prelude_option_set_description (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *description);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id412797"></a><h3> <a name="prelude-option-get-description"></a>prelude_option_get_description ()</h3> <a class="indexterm" name="id412810"></a><pre class="programlisting">const char* prelude_option_get_description (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id412866"></a><h3> <a name="prelude-option-set-has-arg"></a>prelude_option_set_has_arg ()</h3> <a class="indexterm" name="id412879"></a><pre class="programlisting">void prelude_option_set_has_arg (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t">prelude_option_argument_t</a> has_arg);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>has_arg</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id412945"></a><h3> <a name="prelude-option-get-has-arg"></a>prelude_option_get_has_arg ()</h3> <a class="indexterm" name="id412957"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t">prelude_option_argument_t</a> prelude_option_get_has_arg (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id457920"></a><h3> <a name="prelude-option-set-value"></a>prelude_option_set_value ()</h3> <a class="indexterm" name="id457932"></a><pre class="programlisting">void prelude_option_set_value (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *value);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id457998"></a><h3> <a name="prelude-option-get-value"></a>prelude_option_get_value ()</h3> <a class="indexterm" name="id458010"></a><pre class="programlisting">const char* prelude_option_get_value (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id458067"></a><h3> <a name="prelude-option-set-help"></a>prelude_option_set_help ()</h3> <a class="indexterm" name="id458079"></a><pre class="programlisting">void prelude_option_set_help (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *help);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>help</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id458145"></a><h3> <a name="prelude-option-get-help"></a>prelude_option_get_help ()</h3> <a class="indexterm" name="id458157"></a><pre class="programlisting">const char* prelude_option_get_help (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id422141"></a><h3> <a name="prelude-option-set-input-validation-regex"></a>prelude_option_set_input_validation_regex ()</h3> <a class="indexterm" name="id422152"></a><pre class="programlisting">void prelude_option_set_input_validation_regex (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *regex);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>regex</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id422219"></a><h3> <a name="prelude-option-get-input-validation-regex"></a>prelude_option_get_input_validation_regex ()</h3> <a class="indexterm" name="id422230"></a><pre class="programlisting">const char* prelude_option_get_input_validation_regex (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id422287"></a><h3> <a name="prelude-option-set-input-type"></a>prelude_option_set_input_type ()</h3> <a class="indexterm" name="id422300"></a><pre class="programlisting">void prelude_option_set_input_type (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t">prelude_option_input_type_t</a> input_type);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>input_type</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id422366"></a><h3> <a name="prelude-option-get-input-type"></a>prelude_option_get_input_type ()</h3> <a class="indexterm" name="id436889"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t">prelude_option_input_type_t</a> prelude_option_get_input_type (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id436946"></a><h3> <a name="prelude-option-get-optlist"></a>prelude_option_get_optlist ()</h3> <a class="indexterm" name="id436958"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-list.html#prelude-list-t">prelude_list_t</a>* prelude_option_get_optlist (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id437014"></a><h3> <a name="prelude-option-get-next"></a>prelude_option_get_next ()</h3> <a class="indexterm" name="id437026"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a>* prelude_option_get_next (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *start, <a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *cur);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>cur</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id437102"></a><h3> <a name="prelude-option-has-optlist"></a>prelude_option_has_optlist ()</h3> <a class="indexterm" name="id437114"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t">prelude_bool_t</a> prelude_option_has_optlist (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id475322"></a><h3> <a name="prelude-option-get-parent"></a>prelude_option_get_parent ()</h3> <a class="indexterm" name="id475334"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a>* prelude_option_get_parent (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id475389"></a><h3> <a name="prelude-option-set-destroy-callback"></a>prelude_option_set_destroy_callback ()</h3> <a class="indexterm" name="id475402"></a><pre class="programlisting">void prelude_option_set_destroy_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t">prelude_option_destroy_callback_t</a> destroy);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id475468"></a><h3> <a name="prelude-option-get-destroy-callback"></a>prelude_option_get_destroy_callback ()</h3> <a class="indexterm" name="id475480"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t">prelude_option_destroy_callback_t</a> prelude_option_get_destroy_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id475537"></a><h3> <a name="prelude-option-set-set-callback"></a>prelude_option_set_set_callback ()</h3> <a class="indexterm" name="id475549"></a><pre class="programlisting">void prelude_option_set_set_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t">prelude_option_set_callback_t</a> set);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id463157"></a><h3> <a name="prelude-option-get-set-callback"></a>prelude_option_get_set_callback ()</h3> <a class="indexterm" name="id463169"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t">prelude_option_set_callback_t</a> prelude_option_get_set_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id463226"></a><h3> <a name="prelude-option-set-get-callback"></a>prelude_option_set_get_callback ()</h3> <a class="indexterm" name="id463238"></a><pre class="programlisting">void prelude_option_set_get_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, int (getprelude_option_t *opt, prelude_string_t *out, void *context) ());</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>get</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id463304"></a><h3> <a name="prelude-option-get-get-callback"></a>prelude_option_get_get_callback ()</h3> <a class="indexterm" name="id463317"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-get-callback-t">prelude_option_get_callback_t</a> prelude_option_get_get_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id463374"></a><h3> <a name="prelude-option-set-commit-callback"></a>prelude_option_set_commit_callback ()</h3> <a class="indexterm" name="id463386"></a><pre class="programlisting">void prelude_option_set_commit_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t">prelude_option_commit_callback_t</a> commit);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>commit</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id458617"></a><h3> <a name="prelude-option-get-commit-callback"></a>prelude_option_get_commit_callback ()</h3> <a class="indexterm" name="id458630"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t">prelude_option_commit_callback_t</a> prelude_option_get_commit_callback (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id458686"></a><h3> <a name="prelude-option-set-default-context"></a>prelude_option_set_default_context ()</h3> <a class="indexterm" name="id458699"></a><pre class="programlisting">void prelude_option_set_default_context (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, void *context);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id458764"></a><h3> <a name="prelude-option-new-context"></a>prelude_option_new_context ()</h3> <a class="indexterm" name="id458777"></a><pre class="programlisting">int prelude_option_new_context (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, <a class="link" href="libprelude-prelude-option.html#prelude-option-context-t">prelude_option_context_t</a> **ctx, const char *name, void *data);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id461728"></a><h3> <a name="prelude-option-context-destroy"></a>prelude_option_context_destroy ()</h3> <a class="indexterm" name="id461740"></a><pre class="programlisting">void prelude_option_context_destroy (<a class="link" href="libprelude-prelude-option.html#prelude-option-context-t">prelude_option_context_t</a> *oc);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>oc</code></em> :</span></p></td> <td> </td> </tr></tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id461785"></a><h3> <a name="prelude-option-search"></a>prelude_option_search ()</h3> <a class="indexterm" name="id461798"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a>* prelude_option_search (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *parent, const char *name, <a class="link" href="libprelude-prelude-option.html#prelude-option-type-t">prelude_option_type_t</a> type, <a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t">prelude_bool_t</a> walk_children);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>walk_children</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="id461914"></a><h3> <a name="prelude-option-search-context"></a>prelude_option_search_context ()</h3> <a class="indexterm" name="id461927"></a><pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-context-t">prelude_option_context_t</a>* prelude_option_search_context (<a class="link" href="libprelude-prelude-option.html#prelude-option-t">prelude_option_t</a> *opt, const char *name);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>opt</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> <td> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> </td> </tr> </tbody> </table></div> </div> </div> <div class="refsect1" lang="en"> <a name="id462005"></a><div class="refsect2" lang="en"><a name="id462006"></a></div> <hr> <div class="refsect2" lang="en"><a name="id462007"></a></div> </div> </div> </body> </html>