StringIntPairArray Struct Reference

A datatype for storing a set of StringIntPairs. More...

#include <string_int_pair.h>

Collaboration diagram for StringIntPairArray:

Public Member Functions
StringIntPairArray *	AllocateStringIntPairArray (const uint32 size)
	Allocate a StringIntPairArray of a given size. More...
void	FreeStringIntPairArray (StringIntPairArray *array_p)
	Free a StringIntPairArray and any memory associated from its keys where appropriate. More...
void	SortStringIntPairsByCountAscending (StringIntPairArray *pairs_p)
	Sort the entries of a StringIntPairArray into ascending order of their values. More...
void	SortStringIntPairsByCountDescending (StringIntPairArray *pairs_p)
	Sort the entries of a StringIntPairArray into descending order of their values. More...

Data Fields
StringIntPair *	sipa_values_p
	An array of StringIntPairs. More...
uint32	sipa_size
	The number of StringIntPairs in the array. More...

Detailed Description

A datatype for storing a set of StringIntPairs.

Member Function Documentation

AllocateStringIntPairArray()

StringIntPairArray * AllocateStringIntPairArray

(

const uint32

size

)

Allocate a StringIntPairArray of a given size.

Parameters

size	The number of entries in the StringIntPairArray.

Returns

If successful, the newly-allocated StringIntPairArray with all of its keys set to NULL and all of its values set to 0. Upon failure NULL is returned.

See also

StringIntPair

FreeStringIntPairArray()

void FreeStringIntPairArray

(

StringIntPairArray *

array_p

)

Free a StringIntPairArray and any memory associated from its keys where appropriate.

Parameters

array_p

The StringIntPairArray to free.

SortStringIntPairsByCountAscending()

void SortStringIntPairsByCountAscending

(

StringIntPairArray *

pairs_p

)

Sort the entries of a StringIntPairArray into ascending order of their values.

Parameters

pairs_p

The StringIntPairArray to sort.

SortStringIntPairsByCountDescending()

void SortStringIntPairsByCountDescending

(

StringIntPairArray *

pairs_p

)

Sort the entries of a StringIntPairArray into descending order of their values.

Parameters

pairs_p

The StringIntPairArray to sort.

Field Documentation

sipa_values_p

StringIntPair* sipa_values_p

An array of StringIntPairs.

sipa_size

uint32 sipa_size

The number of StringIntPairs in the array.

---

The documentation for this struct was generated from the following file:

• string_int_pair.h