ecoli_node_option - Man Page

Name

ecoli_node_option — Option node

— A node that makes its child optional.  

Synopsis

Functions

struct ec_node * ec_node_option (const char *id, struct ec_node *node)
int ec_node_option_set_child (struct ec_node *gen_node, struct ec_node *child)

Detailed Description

A node that makes its child optional.

Configuration Schema

schema option {
    node child  {
        description "The child node.";
    }
}

Function Documentation

struct ec_node * ec_node_option (const char * id, struct ec_node * node)

Create an option node that makes its child optional.

Parameters

id The node identifier.
node The child node. It is consumed and will be freed when the parent is freed, or immediately on error.

Returns

The node, or NULL on error (errno is set).

int ec_node_option_set_child (struct ec_node * gen_node, struct ec_node * child)

Set the child of an option node.

Parameters

gen_node The option node.
child The child node. It is consumed and will be freed when the parent is freed, or immediately on error.

Returns

0 on success, -1 on error (errno is set).

Author

Generated automatically by Doxygen for Libecoli from the source code.

Referenced By

The man pages ec_node_option(3) and ec_node_option_set_child(3) are aliases of ecoli_node_option(3).

Version 0.11.3 Libecoli