NeoMutt  2020-09-25
Teaching an old dog new tricks
DOXYGEN
Command Struct Reference

A user-callable command. More...

#include "mutt_commands.h"

Data Fields

const char * name
 Name of the command. More...
 
enum CommandResult(* parse )(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Function to parse a command. More...
 
intptr_t data
 Data or flags to pass to the command. More...
 

Detailed Description

A user-callable command.

Definition at line 45 of file mutt_commands.h.

Field Documentation

◆ name

const char* Command::name

Name of the command.

Definition at line 47 of file mutt_commands.h.

◆ parse

enum CommandResult(* Command::parse) (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)

Function to parse a command.

Parameters
bufTemporary Buffer space
sBuffer containing string to be parsed
dataFlags associated with the command
errBuffer for error messages
Return values
CommandResultResult e.g. MUTT_CMD_SUCCESS

Definition at line 57 of file mutt_commands.h.

◆ data

intptr_t Command::data

Data or flags to pass to the command.

Definition at line 59 of file mutt_commands.h.


The documentation for this struct was generated from the following file: