# CSLUserDataList Class Reference

`#include <XSIUserDataList.h>`

Inheritance diagram for CSLUserDataList:

List of all members.

## Public Member Functions
| CSLUserDataList (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual | ~CSLUserDataList ()
| Destructor.
ETemplateType | Type ()
SI_Error | Synchronize ()
CSLUserData * | AddUserData ()
SI_Error | RemoveUserData (SI_Int in_nIndex)
SI_Error | RemoveUserData (CSLUserData *in_pToRemove)
SI_Error | ClearUserDatas ()
CSLUserData * | ConnectUserData (CSLUserData *in_pToConnect)
CSLUserData ** | GetUserDataList ()
SI_Int | GetUserDataCount ()
CSLUserData * | FindUserData (SI_Char *in_szUserDataName)

## Detailed Description

Defines a collection of user-defined data (see the XSI_UserDataList template reference).

Note:
  This template was introduced in dotXSI Version 3.6

See also:
  CSLUserData

  CSLCluster

## Constructor & Destructor Documentation

CSLUserDataList | ( | CSLScene * | in_pScene,
|  | CSLModel * | in_pModel,
|  | CdotXSITemplate * | in_pTemplate |
| ) |  |  |

Constructor

Parameters:

  | in_pScene | Parent scene
  | in_pModel | Parent model
  | in_pTemplate | Refered template

## Member Function Documentation

ETemplateType Type | ( |  | ) | `[inline, virtual]`

Gets the type of this template

Returns:
  ETemplateType The type of this template: XSI_USER_DATA_LIST

Implements CSLTemplate.

SI_Error Synchronize | ( |  | ) | `[virtual]`

Commits semantic layer data

Returns:
  SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

CSLUserData* AddUserData | ( |  | ) |

Adds a user data to the user data list

Returns:
  CSLUserData Pointer to the newly added user data

SI_Error RemoveUserData | ( | SI_Int | in_nIndex | ) |

Removes a user data from the user data list

Parameters:

  | in_nIndex | Index of the user data to remove

Returns:
  SI_Error Whether or not the user data could be removed

SI_Error RemoveUserData | ( | CSLUserData * | in_pToRemove | ) |

Removes a user data from the user data list

Parameters:

  | in_pToRemove | Pointer to the user data to remove

Returns:
  SI_Error Whether or not the user data could be removed

SI_Error ClearUserDatas | ( |  | ) |

Removes all connections points from the user data list

Returns:
  SI_Error Whether or not the list could be cleared

CSLUserData* ConnectUserData | ( | CSLUserData * | in_pToConnect | ) |

Adds a exisiting user data to the user data list

Parameters:

  | in_pToConnect | Pointer to the user data to add

Returns:
  The added user data or null if it already exists in the list

CSLUserData** GetUserDataList | ( |  | ) |

Gets a pointer to the internally-stored UserData pointer list

Returns:
  CSLUserData Pointer to the list

SI_Int GetUserDataCount | ( |  | ) |

Gets the total number of user datas

Returns:
  SI_Int Number of user datas

CSLUserData* FindUserData | ( | SI_Char * | in_szUserDataName | ) |

Searches for a given UserData

Parameters:

  | in_szUserDataName | Name of the user data to look for

Returns:
  CSLUserData Pointer to the user data or null if it canot be found

Reimplemented from CSIBCNode.

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

- XSIUserDataList.h