menu.h File Reference

The UDIF console menu functions. More...

#include "udifcommon.h"
#include "commands.h"

Go to the source code of this file.

Functions
UDIF_EXPORT_API const char *	udif_menu_get_prompt (udif_console_modes mode)
	Returns the console prompt string.
UDIF_EXPORT_API void	udif_menu_print_error (udif_protocol_errors error, udif_console_modes mode, const char *host)
	Print an error message to the console.
UDIF_EXPORT_API void	udif_menu_print_message (const char *message, udif_console_modes mode, const char *host)
	Print a message to the console.
UDIF_EXPORT_API bool	udif_menu_print_message_confirm (const char *message, udif_console_modes mode, const char *host)
	Print a message to the console and wait for confirmation.
UDIF_EXPORT_API void	udif_menu_print_predefined_message (udif_application_messages msgnum, udif_console_modes mode, const char *host)
	Print a predefined message to the console.
UDIF_EXPORT_API bool	udif_menu_print_predefined_message_confirm (udif_application_messages msgnum, udif_console_modes mode, const char *host)
	Print a predefined message to the console and wait for confirmation.
UDIF_EXPORT_API void	udif_menu_print_prompt (udif_console_modes mode, const char *host)
	Print the application prompt.
UDIF_EXPORT_API void	udif_menu_print_prompt_text (const char *message, udif_console_modes mode, const char *host)
	Print a prompt and text with no line terminator.
UDIF_EXPORT_API void	udif_menu_print_predefined_text (udif_application_messages msgnum, udif_console_modes mode, const char *host)
	Print a predefined message with no line terminator.
UDIF_EXPORT_API void	udif_menu_print_text (const char *message)
	Print a text string to the console without a newline.
UDIF_EXPORT_API void	udif_menu_print_text_line (const char *message)
	Print a text string to the console with a newline.
UDIF_EXPORT_API void	udif_menu_print_prompt_empty (void)
	Print the application prompt on an empty line.

Detailed Description

The UDIF console menu functions.

This module provides functions for printing prompts, messages, and errors to the UDIF console. These functions are used to interact with the user by displaying status messages, predefined texts, and user confirmations.

The functions include:

• Retrieving the prompt string for a given console mode.
• Printing error messages derived from protocol error codes.
• Printing plain text messages and predefined messages.
• Printing prompts (with or without text) to the console.

All messages are printed in plain ASCII. No Unicode characters are used.

Example usage:

// Get and print the console prompt for configuration mode.
const char* prompt = udif_menu_get_prompt(udif_console_mode_config);
qsc_consoleutils_print_safe(prompt);
 
// Print an error message based on a protocol error.
udif_menu_print_error(udif_protocol_error_invalid_request, udif_console_mode_config, "Host1");
 
// Print a predefined message and wait for confirmation.
if (udif_menu_print_predefined_message_confirm(udif_application_log_backup, udif_console_mode_config, "Host1"))
{
    // Proceed with backup...
}

Function Documentation

udif_menu_get_prompt()

UDIF_EXPORT_API const char * udif_menu_get_prompt

(

udif_console_modes

mode

)

Returns the console prompt string.

This function returns the appropriate prompt string based on the specified console mode. The prompt is selected from an internal array of mode strings.

Parameters

mode	The current console mode.

Returns

A pointer to the prompt string.

udif_menu_print_error()

UDIF_EXPORT_API void udif_menu_print_error	(	udif_protocol_errors	error,
		udif_console_modes	mode,
		const char *	host )

Print an error message to the console.

This function converts a protocol error code into a descriptive string and prints it to the console. It prints the prompt first (based on the mode and host) and then the error message.

Parameters

error	The protocol error enumerator.
mode	The current console mode.
host	The host name.

udif_menu_print_message()

UDIF_EXPORT_API void udif_menu_print_message	(	const char *	message,
		udif_console_modes	mode,
		const char *	host )

Print a message to the console.

This function prints the given message string to the console. It first prints the prompt (using the current mode and host) and then the message on a new line.

Parameters

message	The message string to print.
mode	The current console mode.
host	The host name.

udif_menu_print_message_confirm()

UDIF_EXPORT_API bool udif_menu_print_message_confirm	(	const char *	message,
		udif_console_modes	mode,
		const char *	host )

Print a message to the console and wait for confirmation.

This function prints a message and then waits for the user to input a single character. If the user enters 'y' or 'Y', the function returns true.

Parameters

message	The message string.
mode	The current console mode.
host	The host name.

Returns

True if the user confirms (answers 'y' or 'Y'); false otherwise.

udif_menu_print_predefined_message()

UDIF_EXPORT_API void udif_menu_print_predefined_message	(	udif_application_messages	msgnum,
		udif_console_modes	mode,
		const char *	host )

Print a predefined message to the console.

This function prints a message that is predefined in the UDIF application. The message is chosen based on the msgnum parameter.

Parameters

msgnum	The predefined message enumerator.
mode	The current console mode.
host	The host name.

udif_menu_print_predefined_message_confirm()

UDIF_EXPORT_API bool udif_menu_print_predefined_message_confirm	(	udif_application_messages	msgnum,
		udif_console_modes	mode,
		const char *	host )

Print a predefined message to the console and wait for confirmation.

This function prints a predefined message and then waits for the user to provide confirmation. A response of 'y' or 'Y' returns true.

Parameters

msgnum	The predefined message enumerator.
mode	The current console mode.
host	The host name.

Returns

True if the user confirms; false otherwise.

udif_menu_print_predefined_text()

UDIF_EXPORT_API void udif_menu_print_predefined_text	(	udif_application_messages	msgnum,
		udif_console_modes	mode,
		const char *	host )

Print a predefined message with no line terminator.

This function prints a predefined message (as defined in the UDIF application messages) without a newline at the end.

Parameters

msgnum	The predefined message enumerator.
mode	The current console mode.
host	The host name.

udif_menu_print_prompt()

UDIF_EXPORT_API void udif_menu_print_prompt	(	udif_console_modes	mode,
		const char *	host )

Print the application prompt.

This function prints the application prompt string to the console using the current console mode and host name.

Parameters

mode	The current console mode.
host	The host name.

udif_menu_print_prompt_empty()

UDIF_EXPORT_API void udif_menu_print_prompt_empty

(

void

)

Print the application prompt on an empty line.

This function prints the default application prompt on a new line.

udif_menu_print_prompt_text()

UDIF_EXPORT_API void udif_menu_print_prompt_text	(	const char *	message,
		udif_console_modes	mode,
		const char *	host )

Print a prompt and text with no line terminator.

This function prints a prompt followed by a message string. The message is printed without appending a newline character.

Parameters

message	The message string to print.
mode	The current console mode.
host	The host name.

udif_menu_print_text()

UDIF_EXPORT_API void udif_menu_print_text

(

const char *

message

)

Print a text string to the console without a newline.

This function prints the specified text string using a safe console print, without appending a newline.

Parameters

message

The message string to print.

udif_menu_print_text_line()

UDIF_EXPORT_API void udif_menu_print_text_line

(

const char *

message

)

Print a text string to the console with a newline.

This function prints the specified text string and then appends a newline.

Parameters

message

The message string to print.