Class BasicSpacesResult

• Defined in File Space.h

Inheritance Relationships

Base Type

• public csp::systems::ResultBase (Class ResultBase)

Class Documentation

class BasicSpacesResult : public csp::systems::ResultBase

Data class used to contain information when attempting to get an array of spaces.

Public Functions

csp::common::Array<BasicSpace> &GetSpaces()

Retrieves the spaces array being stored.

Returns

csp::common::Array<Space> : pointer to spaces array

const csp::common::Array<BasicSpace> &GetSpaces() const

Retrieves the spaces array being stored.

Returns

csp::common::Array<Space> : pointer to spaces array

uint64_t GetTotalCount() const

Retrieves the async operation total number of result spaces.

If the async operation was using pagination this count number represents the sum of space sizes from every page. If the async operation is not using pagination this count number will be equal to the spaces array size.

Returns

uint64_t : count number as described above