Microsoft Azure Storage Client Library for C++  7.5.0
The Microsoft Azure Storage Client Library for C++ is a library for working with the Azure Storage Services in C++.
Public Member Functions | List of all members
azure::storage::continuation_token Class Reference

Represents a continuation token for listing operations. More...

Public Member Functions

 continuation_token ()
 Initializes a new instance of the azure::storage::continuation_token class. More...
 
 continuation_token (utility::string_t next_marker)
 Initializes a new instance of the azure::storage::continuation_token class. More...
 
const utility::string_t & next_marker () const
 Gets the next marker for continuing results for enumeration operations. More...
 
void set_next_marker (utility::string_t next_marker)
 Sets the next marker for continuing results for enumeration operations. More...
 
storage_location target_location () const
 Gets the location that the token applies to. More...
 
void set_target_location (storage_location value)
 Sets the location that the token applies to. More...
 
bool empty () const
 Gets a value indicating whether the continuation token is empty. More...
 

Detailed Description

Represents a continuation token for listing operations.

A method that may return a partial set of results via a result segment object also returns a continuation token, which can be used in a subsequent call to return the next set of available results.

Constructor & Destructor Documentation

◆ continuation_token() [1/2]

azure::storage::continuation_token::continuation_token ( )
inline

Initializes a new instance of the azure::storage::continuation_token class.

◆ continuation_token() [2/2]

azure::storage::continuation_token::continuation_token ( utility::string_t  next_marker)
inlineexplicit

Initializes a new instance of the azure::storage::continuation_token class.

Parameters
next_markerThe next_marker.

Member Function Documentation

◆ empty()

bool azure::storage::continuation_token::empty ( ) const
inline

Gets a value indicating whether the continuation token is empty.

Returns
true if the continuation token is empty; otherwise, false.

◆ next_marker()

const utility::string_t& azure::storage::continuation_token::next_marker ( ) const
inline

Gets the next marker for continuing results for enumeration operations.

Returns
The next marker for continuing results for enumeration operations.

◆ set_next_marker()

void azure::storage::continuation_token::set_next_marker ( utility::string_t  next_marker)
inline

Sets the next marker for continuing results for enumeration operations.

Parameters
next_markerThe next marker for continuing results for enumeration operations.

◆ set_target_location()

void azure::storage::continuation_token::set_target_location ( storage_location  value)
inline

Sets the location that the token applies to.

Parameters
valueThe location that the token applies to.

◆ target_location()

storage_location azure::storage::continuation_token::target_location ( ) const
inline

Gets the location that the token applies to.

Returns
The location that the token applies to.