jCommandLine.h File Reference

#include "jTypes.h"

Include dependency graph for jCommandLine.h:

This graph shows which files directly or indirectly include this file:

Functions
void	JWaitForReturn ()
void	JInputFinished ()
void	JCheckForValues (const JSize valueCount, JIndex *index, const JSize argc, char *argv[])
bool	JIsVersionRequest (const JUtf8Byte *arg)
bool	JIsHelpRequest (const JUtf8Byte *arg)

Function Documentation

JCheckForValues()

void JCheckForValues	(	const JSize	valueCount,
		JIndex *	index,
		const JSize	argc,
		char *	argv[]
	)

Useful when parsing command line options. *index must point to the option marker. If there are fewer than valueCount arguments following this marker, notifies user how many arguments are missing and exits. Otherwise, increments *index so it points to the first value.

JInputFinished()

void JInputFinished

(

)

When you are done getting information from the user, call this to remove the last return typed by the user.

This ensures that JWaitForReturn will work the first time.

JIsHelpRequest()

bool JIsHelpRequest

(

const JUtf8Byte *

arg

)

JIsVersionRequest()

bool JIsVersionRequest

(

const JUtf8Byte *

arg

)

JWaitForReturn()

void JWaitForReturn

(

)