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

Typedefs
typedef char *	String
	Copyright (c) 2013-2014 by Wayne C. Gramlich. All rights reserved.
typedef const char *	String_Const
Functions
String	String__allocate (unsigned int size)
	Allocate and return for size characters.
bool	String__equal (String_Const string1, String_Const string2)
	Returns true if string1 equals string2.
String	String__format (String_Const format,...)
	Return a formatted version of format.
void	String__free (String_Const string)
	will free memory assciated with string.
unsigned int	String__size (String_Const string)
	Returns the size of string.
unsigned int	String__to_unsigned (String_Const string)
	Converts from decimal string into a number and return it.

Typedef Documentation

typedef char* String

*String* is a null-terminated string.

Definition at line 8 of file String.hpp.

typedef const char* String_Const

Definition at line 9 of file String.hpp.

Function Documentation

String String__allocate ( unsigned int size )

Allocate and return for *size* characters.

Parameters:

size	is the maximum string size excluding trailing null.

Returns:: allocated *String* object.

String__allocate*() will return a string that can conatain size* characters excluding trailing null.

Definition at line 19 of file String.cpp.

bool String__equal	(	String_Const	string1,
		String_Const	string2
	)

Returns true if *string1* equals *string2*.

Parameters:

string1	is the first String to compare.
string2	is the second String to compare.

Returns:: true if *string1* is equal to *string2*.

String__equal*() will return true if *string1* is equal to *string2* and false otherwise.

Definition at line 31 of file String.cpp.

String String__format	(	String_Const	format,
			...
	)

Return a formatted version of *format*.

Parameters:

format	is the string to format.
...	are the addition arguments to be formatted.

Returns:: the formatted string.

String__format*() will a formatted version of *format* using the additional variadic arguements.

Definition at line 43 of file String.cpp.

void String__free ( String_Const string )

will free memory assciated with *string*.

Parameters:

string to free.

Definition at line 65 of file String.cpp.

unsigned int String__size ( String_Const string )

Returns the size of *string*.

Parameters:

string to get size of.

Returns:: size of string.

String__size*() will return the size size of *string*.

Definition at line 75 of file String.cpp.

unsigned int String__to_unsigned ( String_Const string )

Converts from decimal string into a number and return it.

Parameters:

string to convert.

String__to_unsigned*() will convert from decimal string into a number and return it.

Definition at line 90 of file String.cpp.

Typedefs

Functions

Typedef Documentation

Function Documentation