# CdotXSIParams Class Reference

`#include <dotXSIParams.h>`

List of all members.

## Public Member Functions
| CdotXSIParams ()
virtual | ~CdotXSIParams ()
SI_Int | GetCount ()
SI_Void | Add (CdotXSIParam *i_Param, SI_Int i_nPosition)
SI_Void | Item (SI_Int i_nPosition, CdotXSIParam **o_Param)
CdotXSIParam * | Item (SI_Int i_nPosition)
SI_Void | Remove (SI_Int i_nPosition)
SI_Void | Clear ()
SI_Bool | Find (CSIBCString *i_sParamName, CdotXSIParam **o_pParam)
CdotXSIParam * | Find (const SI_Char *in_szParamName)

## Detailed Description

container for an array of CdotXSIParam elements

## Constructor & Destructor Documentation

CdotXSIParams | ( |  | ) |

Constructor

virtual ~CdotXSIParams | ( |  | ) | `[virtual]`

Destructor

## Member Function Documentation

SI_Int GetCount | ( |  | ) |

Get the number of elements

Returns:
  SI_Int the number of CdotXSIParam in this collection

SI_Void Add | ( | CdotXSIParam * | i_Param,
|  | SI_Int | i_nPosition |
| ) |  |  |

Add an element to this collection

Parameters:

  | i_Param | the CdotXSIParam to add to this collection
  | i_nPosition | the position to add this element at

Returns:
  SI_Void

SI_Void Item | ( | SI_Int | i_nPosition,
|  | CdotXSIParam ** | o_Param |
| ) |  |  |

Get an item

Parameters:

  | i_nPosition | position to get the item at
  | o_Param | a pointer to a CdotXSIParam* to store a reference to the item

Returns:
  SI_Void

CdotXSIParam* Item | ( | SI_Int | i_nPosition | ) |

Get an item

Parameters:

  | i_nPosition | position to get the item at

Returns:
  CdotXSIParam* a pointer to the requested item

SI_Void Remove | ( | SI_Int | i_nPosition | ) |

Remove the specified element

Parameters:

  | i_nPosition | the position to remove the item at

Returns:
  SI_Void

SI_Void Clear | ( |  | ) |

Clear the entire collection of all elements

Returns:
  SI_Void

SI_Bool Find | ( | CSIBCString * | i_sParamName,
|  | CdotXSIParam ** | o_pParam |
| ) |  |  |

Find an element by name

Parameters:

  | i_sParamName | the name of the parameter to find
  | o_Param | a pointer to a CdotXSIParam* to store a reference to the item

Returns:
  SI_Bool whether the element has been found or not

CdotXSIParam* Find | ( | const SI_Char * | in_szParamName | ) |

Find an element by name

Parameters:

  | i_sParamName | the name of the parameter to find

Returns:
  CdotXSIParam* the param or NULL

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

- dotXSIParams.h