cmdline.h File Reference

#include <termios.h>
#include <cmdline_rdline.h>
#include <cmdline_parse.h>

Go to the source code of this file.

Functions
int	cmdline_poll (struct cmdline *cl)

Detailed Description

Command line API

Definition in file cmdline.h.

Function Documentation

cmdline_poll()

int cmdline_poll

(

struct cmdline *

cl

)

This function is nonblocking equivalent of cmdline_interact(). It polls cl for one character and interpret it. If return value is RDLINE_EXITED it mean that cmdline_quit() was invoked.

Parameters

cl	The command line object.

Returns

On success return object status - one of enum rdline_status. On error return negative value.