ost::CommandOptionArg(3)

📦 version 1.8.1, in ubuntu jammy

💖 ost::CommandOptionArg 💖

okay bestie, welcome to the Library Functions Manual section of the GNU CommonC++ world — this is a little class that handles options that need a value to come with them. yes, the fancy ones. the main character options. ✨

🌸 NAME 🌸

ost::CommandOptionArg — Class for options with an argument e.g.

🎀 SYNOPSIS 🎀

#include <cmdoptns.h>

Inherits ost::CommandOptionWithArg.

🦋 Public Member Functions 🦋

  • CommandOptionArg(const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) — CommandOptionArg contructor.
  • virtual ~CommandOptionArg()

💜 Additional Inherited Members

🌈 Detailed Description 🌈

Class for options with an argument e.g.

--option value

⭐ Examples

cmdlineopt.cpp.

bestie go look at cmdlineopt.cpp if you want to see this whole thing in the wild, it's giving tutorial energy fr fr 🫶

💅 Constructor & Destructor Documentation 💅

✨ ost::CommandOptionArg::CommandOptionArg ✨

ost::CommandOptionArg::CommandOptionArg (
    const char * inOptionName,
    const char * inOptionLetter,
    const char * inDescription,
    bool inRequired = false,
    CommandOption ** ppNext = &defaultCommandOptionList
)

CommandOptionArg contructor. This sets the optionType for this object to HasArg.

Like, that's literally the whole point of this class — it tells the system "hey, this option comes with a value attached" and the optionType gets set to HasArg. periodt. 👑

🍓 Parameters

  • inOptionName — long option name
  • inOptionLetter — short letter name
  • inDescription — short description of the option
  • inRequired — true if option is required
  • ppNext — the linked list header

🧚 ost::CommandOptionArg::~CommandOptionArg 🧚

virtual ost::CommandOptionArg::~CommandOptionArg () [virtual]

👑 Author 👑

Generated automatically by Doxygen for GNU CommonC++ from the source code.

and that's the whole vibe check, bestie — this page is from GNU CommonC++, dated Sun Dec 27 2020, so you know exactly where it came from. slay 💖🎀✨

📦 where this page comes from