RTEMS 4.10.0 On-Line Library

General Commands unsetenv - unset environment variable

RTEMS Shell User's Guide

2.2.10: unsetenv - unset environment variable

SYNOPSYS:

unsetenv variable

DESCRIPTION:

This command is remove to a variable from the set of environment variables.

EXIT STATUS:

This command will return 1 and print a diagnostic message if a failure occurs.

NOTES:

The entire RTEMS application shares a single set of environment variables.

EXAMPLES:

The following is an example of how to use unsetenv:

SHLL [/] $ unsetenv BASEPATH

CONFIGURATION:

This command is included in the default shell command set. When building a custom command set, define CONFIGURE_SHELL_COMMAND_UNSETENV to have this command included.

This command can be excluded from the shell command set by defining CONFIGURE_SHELL_NO_COMMAND_UNSETENV when all shell commands have been configured.

PROGRAMMING INFORMATION:

The unsetenv is implemented by a C language function which has the following prototype:

int rtems_shell_rtems_main_unsetenv(
  int    argc,
  char **argv
);

The configuration structure for the unsetenv has the following prototype:

extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command;

RTEMS Shell User's Guide