Accessor gives access to the user data values stored in a CDataArray2DCustomType object.
#include <xsi_dataarray2D.h>
Public Member Functions | |
Accessor () | |
Accessor (const Accessor &in_accessor) | |
Accessor & | operator= (const Accessor &in_accessor) |
SICPPSDK_INLINE CStatus | SetData (ULONG in_nIndex, const TData *in_pData, ULONG in_nSize) |
SICPPSDK_INLINE CStatus | GetData (ULONG in_nIndex, const TData **out_ppData, ULONG &out_nSize) const |
SICPPSDK_INLINE CStatus | GetData (ULONG in_nIndex, TData **out_ppData, ULONG &out_nSize) const |
SICPPSDK_INLINE TData * | Resize (ULONG in_nIndex, ULONG in_nSize) |
ULONG | GetCount () const |
Accessor | ( | ) | [inline] |
Constructor.
Constructs an Accessor object from another Accessor object.
in_accessor | constant Accessor object. |
Assignment operator.
in_accessor | constant class object. |
SICPPSDK_INLINE CStatus SetData | ( | ULONG | in_nIndex, |
const TData * | in_pData, | ||
ULONG | in_nSize | ||
) |
Allocates in_nSize
bytes of memory for the user data at a specified position and copies the content of in_pData
to the new user array. Use Accessor::Resize if you only need to allocate the memory.
in_nIndex | Array index to store the user data. |
in_pData | Pointer to user data. |
in_nSize | Size in bytes of the data to store. |
SICPPSDK_INLINE CStatus GetData | ( | ULONG | in_nIndex, |
const TData ** | out_ppData, | ||
ULONG & | out_nSize | ||
) | const |
Returns a pointer to the user data stored at a specified position. The data is read-only and cannot be modified.
in_nIndex | Array index of the user data to retrieve. |
out_ppData | Read-only pointer to the data. |
out_nSize | Size in bytes of the user data. |
SICPPSDK_INLINE CStatus GetData | ( | ULONG | in_nIndex, |
TData ** | out_ppData, | ||
ULONG & | out_nSize | ||
) | const |
Returns a pointer to the user data stored in at a specified position. The data can be modified directly.
in_nIndex | Array index of the user data to retrieve. |
out_ppData | Pointer to the data. |
out_nSize | Size in bytes of the user data. |
SICPPSDK_INLINE CDataArray2DCustomType::TData * Resize | ( | ULONG | in_nIndex, |
ULONG | in_nSize | ||
) |
Changes the size of the sub-array buffer at a specified position and returns a pointer to the allocated data.
in_nIndex | Array index of the user buffer to resize. |
in_nSize | The size in bytes of the new array. |
ULONG GetCount | ( | void | ) | const [inline] |
Returns the number of elements in the sub-array.