Dokumentacja klasy common::CmdLineParser
[Moduł Base]

Parser wiersza poleceń. Więcej...

#include <Base.hpp>

Lista wszystkich składowych.

Typy publiczne
enum	RESULT { RESULT_OPT, RESULT_PARAMETER, RESULT_END, RESULT_ERROR }
	Rodzaj pobranej informacji. Więcej...
Metody publiczne
	CmdLineParser (int argc, tchar **argv)
	Wersja dla main(int argc, char **argv).
	CmdLineParser (const tchar *CmdLine)
	Wersja dla WinMain(HINSTANCE Instance, HINSTANCE, char *CmdLine, int CmdShow).
	~CmdLineParser ()
void	RegisterOpt (uint Id, tchar Opt, bool Parameter)
	Rejestruje opcję jednoznakową.
void	RegisterOpt (uint Id, const tstring &Opt, bool Parameter)
	Rejestruje opcję wieloznakową.
RESULT	ReadNext ()
	Wczytuje następną informację, zwraca jej rodzaj.
uint	GetOptId ()
	Zwraca dane na temat ostatnio wczytanej informacji - identyfikator opcji.
const tstring &	GetParameter ()
	Zwraca dane na temat ostatnio wczytanej informacji - treść parametru.

---

Opis szczegółowy

Parser wiersza poleceń.

---

Dokumentacja składowych wyliczanych

enum common::CmdLineParser::RESULT

Rodzaj pobranej informacji.

Wartości wyliczeń:

RESULT_OPT	Opcja.
RESULT_PARAMETER	Goły parametr bez opcji.
RESULT_END	Koniec parametrów.
RESULT_ERROR	Błąd składni.

---

Dokumentacja konstruktora i destruktora

common::CmdLineParser::CmdLineParser	(	int	argc,
		tchar **	argv
	)

Wersja dla main(int argc, char **argv).

common::CmdLineParser::CmdLineParser

(

const tchar *

CmdLine

)

Wersja dla WinMain(HINSTANCE Instance, HINSTANCE, char *CmdLine, int CmdShow).

common::CmdLineParser::~CmdLineParser

(

)

---

Dokumentacja funkcji składowych

void common::CmdLineParser::RegisterOpt	(	uint	Id,
		tchar	Opt,
		bool	Parameter
	)

Rejestruje opcję jednoznakową.

Parametry:

Id

podawać liczby większe od 0.

void common::CmdLineParser::RegisterOpt	(	uint	Id,
		const tstring &	Opt,
		bool	Parameter
	)

Rejestruje opcję wieloznakową.

Parametry:

Id

podawać liczby większe od 0.

RESULT common::CmdLineParser::ReadNext

(

)

Wczytuje następną informację, zwraca jej rodzaj.

uint common::CmdLineParser::GetOptId

(

)

Zwraca dane na temat ostatnio wczytanej informacji - identyfikator opcji.

Jeśli nie została wczytana opcja, zwraca 0.

const tstring& common::CmdLineParser::GetParameter

(

)

Zwraca dane na temat ostatnio wczytanej informacji - treść parametru.

Jeśli nie ma, łańcuch pusty.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Base.hpp