Get() [2/3]

template<typename T >

void drama::sds::Id::Get ( const unsigned long  length, T *const  data, unsigned long *  actlen = nullptr, const unsigned long  offset = 0  ) const

inline

Get data from an SDS item.

This method accesses the data from an SDS item. The data is copied into the specified buffer.

Note that data from nested structures is also copied. Please see the SDS manual for more details on Get operations.

See also

SdsGet()

sds::Id::Pointer

sds::Id::Put

SdsPut()

Template Parameters

T	The type of the data item. This needs to be a of standard layout (Plain old data) types, if not, compile will fail with a static assertion.

Parameters

length	The amount of data to fetch.
data	The buffer to put the data info, must of of size length or greater.
actlen	The actual amount of data retrived is written here. If not supplied, this information is not returned.
offset	An offset into the SDS structure to start fetch from, in bytes

Examples

argtest.cpp, dramahello.cpp, and threadbasic.cpp.

References drama::CreateRunDramaTask(), and DramaTHROW.