epicsReadline.h File Reference

Command-line editing functions. More...

#include <libComAPI.h>
#include <stdio.h>

Include dependency graph for epicsReadline.h:

Go to the source code of this file.

Functions
LIBCOM_API void *epicsStdCall	epicsReadlineBegin (FILE *in)
	Create a command-line context. More...
LIBCOM_API char *epicsStdCall	epicsReadline (const char *prompt, void *context)
	Read a line of input. More...
LIBCOM_API void epicsStdCall	epicsReadlineEnd (void *context)
	Destroy a command-line context. More...

Detailed Description

Author

Eric Norum

Provides a generalized API for command line history and line-editing. The implementation of this API can call GNU Readline, libtecla, and on VxWorks the ledLib routines, according to the EPICS build configuration.

Definition in file epicsReadline.h.

Function Documentation

epicsReadlineBegin()

LIBCOM_API void* epicsStdCall epicsReadlineBegin

(

FILE *

in

)

Parameters

in	Filehandle to read from

Returns

Command-line context

epicsReadline()

LIBCOM_API char* epicsStdCall epicsReadline	(	const char *	prompt,
		void *	context
	)

Parameters

prompt	Prompt string
context	To read from

Returns

Line read

epicsReadlineEnd()

LIBCOM_API void epicsStdCall epicsReadlineEnd

(

void *

context

)

Parameters

context

Command-line context to destroy