help.h File Reference

UDIF Help and Guidance Functions. More...

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

Go to the source code of this file.

Functions
UDIF_EXPORT_API void	udif_help_print_context (const char *prompt, udif_command_actions command)
	Print a help string associated with a command action.
UDIF_EXPORT_API void	udif_help_print_mode (const char *prompt, udif_console_modes mode, udif_network_designations designation)
	Print a console prompt with help text for the current mode.

Detailed Description

UDIF Help and Guidance Functions.

This header declares functions that provide context-sensitive help messages for the UDIF console interface. These functions print help strings that explain available command actions and options based on the current console mode (e.g., configuration, enable, or user mode) and the device's network designation (e.g., APS, Client, ADC, ARS). The help functions make use of pre-defined help text strings (stored in the UDIF_APPLICATION_HELP_STRINGS array) and output them using the QSC console utilities.

The primary functions provided in this module are:

• udif_help_print_context(): Prints a single help message associated with a specific command action.
• udif_help_print_mode(): Prints a set of help messages tailored to the current console mode and network designation.

These functions are essential for providing users with guidance on how to interact with the UDIF system.

Function Documentation

udif_help_print_context()

UDIF_EXPORT_API void udif_help_print_context	(	const char *	prompt,
		udif_command_actions	command )

Print a help string associated with a command action.

This function prints a context-specific help message corresponding to the given command action. The help string is printed using the provided console prompt.

Parameters

prompt	[in] The console prompt string.
command	The command action (from the udif_command_actions enumeration) for which to display help.

udif_help_print_mode()

UDIF_EXPORT_API void udif_help_print_mode	(	const char *	prompt,
		udif_console_modes	mode,
		udif_network_designations	designation )

Print a console prompt with help text for the current mode.

This function prints a set of help messages that are appropriate for the current console mode and the server type designation. It guides the user by displaying available commands and their context based on whether the console is in configuration, enable, or user mode.

Parameters

prompt	[in] The console prompt string.
mode	The current console mode (from the udif_console_modes enumeration).
designation	The network designation (from the udif_network_designations enumeration) for which the help messages should be tailored.