Skip to content

File wsh_shell_cmd_def.h

FileList > src > wsh_shell_cmd_def.h

Go to the source code of this file

Declaration of default shell commands and their option tables. More...

  • #include "wsh_shell_cfg.h"
  • #include "wsh_shell_cmd.h"
  • #include "wsh_shell_history.h"
  • #include "wsh_shell_types.h"

Public Functions

Type Name
const WshShellCmd_t * WshShellDefCmd_GetPtr (void)
Get a pointer to the default shell command structure.

Detailed Description

This header defines macros and functions for registering and executing a set of built-in shell commands. Each command is associated with a predefined option table and an executable handler.

These default commands provide core shell functionality such as help, user info, clearing the screen, and managing command history.

Author:

Whoosh Embedded Team

Copyright:

Copyright (c) 2025

Public Functions Documentation

function WshShellDefCmd_GetPtr

Get a pointer to the default shell command structure. 

1
2
3
const WshShellCmd_t * WshShellDefCmd_GetPtr (
    void
)

This function returns a constant pointer to the static command structure WshShellDefCmd, which describes the default command used for configuring and querying the shell interface.

Returns:

const WshShellCmd_t* Pointer to the default command structure.

The documentation for this class was generated from the following file src/wsh_shell_cmd_def.h