Functions
String.cpp File Reference
#include <assert.h>
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include "String.hpp"
#include "Memory.hpp"
Include dependency graph for String.cpp:

Go to the source code of this file.

Functions

String String__allocate (unsigned int size)
 Allocate and return for size characters. More...
 
bool String__equal (String_Const string1, String_Const string2)
 Returns true if string1 equals string2. More...
 
String String__format (String_Const format,...)
 Return a formatted version of format. More...
 
void String__free (String_Const string)
 will free memory assciated with string. More...
 
unsigned int String__size (String_Const string)
 Returns the size of string. More...
 
unsigned int String__to_unsigned (String_Const string)
 Converts from decimal string into a number and return it. More...
 

Function Documentation

String String__allocate ( unsigned int  size)

Allocate and return for size characters.

Parameters
sizeis 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
string1is the first String to compare.
string2is 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
formatis 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
stringto free.

Definition at line 65 of file String.cpp.

unsigned int String__size ( String_Const  string)

Returns the size of string.

Parameters
stringto 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
stringto convert.

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

Definition at line 90 of file String.cpp.



fiducial_lib
Author(s): Wayne Gramlich
autogenerated on Thu Dec 28 2017 04:06:53