# CSLUserDataBlob Class Reference

`#include <XSIUserData.h>`

Inheritance diagram for CSLUserDataBlob:

List of all members.

## Public Types
typedef CSLArrayProxy< SI_UByte, SI_UByte, 1 > | CSLUByteArray
| Unsigned Byte array proxy class that works like an array of SI_UByte.
## Public Member Functions
| CSLUserDataBlob (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, CSLTemplate *in_pAttachTo=NULL)
virtual | ~CSLUserDataBlob ()
| Destructor.
ETemplateType | Type ()
SI_Error | Synchronize ()
SI_UByte * | GetUserDataPtr ()
CSLUByteArray * | GetUserData ()
SI_Int | GetUserDataSize ()

## Detailed Description

Defines user-defined data (see the XSI_UserDataBlob template reference).

Note:
  This template was introduced in dotXSI Version 5.0

See also:
  CSLUserDataBlob

## Constructor & Destructor Documentation

CSLUserDataBlob | ( | CSLScene * | in_pScene,
|  | CSLModel * | in_pModel,
|  | CdotXSITemplate * | in_pTemplate,
|  | CSLTemplate * | in_pAttachTo = `NULL` |
| ) |  |  |

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_BLOB

Implements CSLTemplate.

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

Commits semantic layer data

Returns:
  SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

SI_UByte* GetUserDataPtr | ( |  | ) |

Gets pointer the user data array

Returns:
  SI_UByte Pointer to the array containing the user data

CSLUByteArray* GetUserData | ( |  | ) |

Gets the user data array

Returns:
  CSLUByteArray Array of user data

SI_Int GetUserDataSize | ( |  | ) |

Gets the size of the user data array

Returns:
  SI_Int size of the user data

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

- XSIUserData.h