azure::storage::cloud_file_directory Class Reference

Represents a directory of files. More...

Public Member Functions
	cloud_file_directory ()
	Initializes a new instance of the azure::storage::cloud_file_directory class. More...
WASTORAGE_API	cloud_file_directory (storage_uri uri)
	Initializes a new instance of the azure::storage::cloud_file_directory class. More...
WASTORAGE_API	cloud_file_directory (storage_uri uri, storage_credentials credentials)
	Initializes a new instance of the azure::storage::cloud_file_directory class. More...
WASTORAGE_API	cloud_file_directory (utility::string_t name, cloud_file_share share)
	Initializes a new instance of the azure::storage::cloud_file_directory class. More...
WASTORAGE_API	cloud_file_directory (utility::string_t name, cloud_file_share share, cloud_file_directory_properties properties, cloud_metadata metadata)
	Initializes a new instance of the azure::storage::cloud_file_directory class. More...
WASTORAGE_API	cloud_file_directory (utility::string_t name, cloud_file_directory directory)
	Initializes a new instance of the azure::storage::cloud_file_directory class. More...
WASTORAGE_API	cloud_file_directory (utility::string_t name, cloud_file_directory directory, cloud_file_directory_properties properties, cloud_metadata metadata)
	Initializes a new instance of the azure::storage::cloud_file_directory class. More...
list_file_and_diretory_result_iterator	list_files_and_directories () const
	Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_diretory_result_iterator	list_files_and_directories (const utility::string_t &prefix) const
	Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_diretory_result_iterator	list_files_and_directories (int64_t max_results) const
	Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_diretory_result_iterator	list_files_and_directories (const utility::string_t &prefix, int64_t max_results) const
	Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_diretory_result_iterator	list_files_and_directories (int64_t max_results, const file_request_options &options, operation_context context) const
	Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items. More...
WASTORAGE_API list_file_and_diretory_result_iterator	list_files_and_directories (const utility::string_t &prefix, int64_t max_results, const file_request_options &options, operation_context context) const
	Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_directory_result_segment	list_files_and_directories_segmented (const continuation_token &token) const
	Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_directory_result_segment	list_files_and_directories_segmented (const utility::string_t &prefix, const continuation_token &token) const
	Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_directory_result_segment	list_files_and_directories_segmented (int64_t max_results, const continuation_token &token, const file_request_options &options, operation_context context) const
	Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
list_file_and_directory_result_segment	list_files_and_directories_segmented (const utility::string_t &prefix, int64_t max_results, const continuation_token &token, const file_request_options &options, operation_context context) const
	Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
pplx::task< list_file_and_directory_result_segment >	list_files_and_directories_segmented_async (const continuation_token &token) const
	Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
pplx::task< list_file_and_directory_result_segment >	list_files_and_directories_segmented_async (const utility::string_t &prefix, const continuation_token &token) const
	Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
pplx::task< list_file_and_directory_result_segment >	list_files_and_directories_segmented_async (int64_t max_results, const continuation_token &token, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
WASTORAGE_API pplx::task< list_file_and_directory_result_segment >	list_files_and_directories_segmented_async (const utility::string_t &prefix, int64_t max_results, const continuation_token &token, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items. More...
void	create ()
	Creates the directory. All parent directories must already be created. More...
void	create (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Creates the directory. All parent directories must already be created. More...
pplx::task< void >	create_async ()
	Intitiates an asynchronous operation to create the directory. All parent directories must already be created. More...
WASTORAGE_API pplx::task< void >	create_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the directory. All parent directories must already be created. More...
bool	create_if_not_exists ()
	Creates the directory if it does not already exist. More...
bool	create_if_not_exists (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Creates the directory if it does not already exist. More...
pplx::task< bool >	create_if_not_exists_async ()
	Intitiates an asynchronous operation to create the directory if it does not already exist. More...
WASTORAGE_API pplx::task< bool >	create_if_not_exists_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the directory if it does not already exist. More...
void	delete_directory ()
	Deletes the directory. More...
void	delete_directory (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Deletes the directory. More...
pplx::task< void >	delete_directory_async ()
	Intitiates an asynchronous operation to delete the directory. More...
WASTORAGE_API pplx::task< void >	delete_directory_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the directory. More...
bool	delete_directory_if_exists ()
	Deletes the directory if it does exist. More...
bool	delete_directory_if_exists (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Deletes the directory if it does exist. More...
pplx::task< bool >	delete_directory_if_exists_async ()
	Intitiates an asynchronous operation to delete the directory if it does exist. More...
WASTORAGE_API pplx::task< bool >	delete_directory_if_exists_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the directory if it does exist. More...
bool	exists ()
	Checks existence of the directory. More...
bool	exists (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Checks existence of the directory. More...
pplx::task< bool >	exists_async ()
	Intitiates an asynchronous operation to check existence of the directory. More...
pplx::task< bool >	exists_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to check existence of the directory. More...
void	download_attributes ()
	Retrieves the directory's attributes. More...
void	download_attributes (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Retrieves the directory's attributes. More...
pplx::task< void >	download_attributes_async ()
	Intitiates an asynchronous operation to retrieve the directory's attributes. More...
WASTORAGE_API pplx::task< void >	download_attributes_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to retrieve the directory's attributes. More...
void	upload_properties () const
	Updates the directory's properties. More...
void	upload_properties (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Updates the directory's properties. More...
pplx::task< void >	upload_properties_async () const
	Intitiates an asynchronous operation to update the directory's properties. More...
WASTORAGE_API pplx::task< void >	upload_properties_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to update the directory's properties. More...
void	upload_metadata () const
	Uploads the directory's metadata. More...
void	upload_metadata (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Uploads the directory's metadata. More...
pplx::task< void >	upload_metadata_async () const
	Intitiates an asynchronous operation to upload the directory's metadata. More...
WASTORAGE_API pplx::task< void >	upload_metadata_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to upload the directory's metadata. More...
cloud_file_directory	get_subdirectory_reference (utility::string_t name) const
	Gets a reference to a sub directory. More...
WASTORAGE_API cloud_file	get_file_reference (const utility::string_t &name) const
	Gets a reference to a file. More...
WASTORAGE_API cloud_file_directory	get_parent_directory_reference () const
	Gets a reference to parent directory. More...
cloud_file_share	get_parent_share_reference () const
	Gets a reference to parent share. More...
const cloud_file_client &	service_client () const
	Gets the azure::storage::cloud_file_client object that represents the File service. More...
const utility::string_t &	name () const
	Gets the directory's name. More...
const storage_uri &	uri () const
	Gets the directory URI for all locations. More...
cloud_metadata &	metadata ()
	Gets the directory's system metadata. More...
const cloud_metadata &	metadata () const
	Gets the directory's system metadata. More...
cloud_file_directory_properties &	properties ()
	Gets the directory's system properties. More...
const cloud_file_directory_properties &	properties () const
	Gets the directory's system properties. More...

Detailed Description

Represents a directory of files.

Shares, which are encapsulated as azure::storage::cloud_file_share objects, hold directories, and directories hold files. Directories can also contain sub-directories.

Constructor & Destructor Documentation

cloud_file_directory() [1/7]

azure::storage::cloud_file_directory::cloud_file_directory ( )

inline

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

cloud_file_directory() [2/7]

WASTORAGE_API azure::storage::cloud_file_directory::cloud_file_directory

(

storage_uri

uri

)

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

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the directory for all locations.

cloud_file_directory() [3/7]

WASTORAGE_API azure::storage::cloud_file_directory::cloud_file_directory	(	storage_uri	uri,
		storage_credentials	credentials
	)

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

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the directory for all locations.
credentials	The azure::storage::storage_credentials to use.

cloud_file_directory() [4/7]

WASTORAGE_API azure::storage::cloud_file_directory::cloud_file_directory	(	utility::string_t	name,
		cloud_file_share	share
	)

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

Parameters

name	The name of the directory.
share	The File share it blongs to.

cloud_file_directory() [5/7]

WASTORAGE_API azure::storage::cloud_file_directory::cloud_file_directory	(	utility::string_t	name,
		cloud_file_share	share,
		cloud_file_directory_properties	properties,
		cloud_metadata	metadata
	)

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

Parameters

name	The name of the directory.
share	The File share it blongs to.
properties	A set of properties for the directory.
metadata	A collection of name-value pairs defining the metadata of the directory.

cloud_file_directory() [6/7]

WASTORAGE_API azure::storage::cloud_file_directory::cloud_file_directory	(	utility::string_t	name,
		cloud_file_directory	directory
	)

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

Parameters

name	The name of the directory.
share	The File directory it blongs to.

cloud_file_directory() [7/7]

WASTORAGE_API azure::storage::cloud_file_directory::cloud_file_directory	(	utility::string_t	name,
		cloud_file_directory	directory,
		cloud_file_directory_properties	properties,
		cloud_metadata	metadata
	)

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

Parameters

name	The name of the directory.
share	The File directory it blongs to.
properties	A set of properties for the directory.
metadata	A collection of name-value pairs defining the metadata of the directory.

Member Function Documentation

create() [1/2]

void azure::storage::cloud_file_directory::create ( )

inline

Creates the directory. All parent directories must already be created.

create() [2/2]

void azure::storage::cloud_file_directory::create ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Creates the directory. All parent directories must already be created.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

create_async() [1/2]

pplx::task<void> azure::storage::cloud_file_directory::create_async ( )

inline

Intitiates an asynchronous operation to create the directory. All parent directories must already be created.

Returns

A pplx::task object that that represents the current operation.

create_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_directory::create_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the directory. All parent directories must already be created.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A pplx::task object that that represents the current operation.

create_if_not_exists() [1/2]

bool azure::storage::cloud_file_directory::create_if_not_exists ( )

inline

Creates the directory if it does not already exist.

Returns

true if the directory did not already exist and was created; otherwise false.

create_if_not_exists() [2/2]

bool azure::storage::cloud_file_directory::create_if_not_exists ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Creates the directory if it does not already exist.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

true if the directory did not already exist and was created; otherwise false.

create_if_not_exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file_directory::create_if_not_exists_async ( )

inline

Intitiates an asynchronous operation to create the directory if it does not already exist.

Returns

A pplx::task object that that represents the current operation.

create_if_not_exists_async() [2/2]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_file_directory::create_if_not_exists_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the directory if it does not already exist.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A pplx::task object that that represents the current operation.

delete_directory() [1/2]

void azure::storage::cloud_file_directory::delete_directory ( )

inline

Deletes the directory.

delete_directory() [2/2]

void azure::storage::cloud_file_directory::delete_directory ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Deletes the directory.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

delete_directory_async() [1/2]

pplx::task<void> azure::storage::cloud_file_directory::delete_directory_async ( )

inline

Intitiates an asynchronous operation to delete the directory.

Returns

A pplx::task object that that represents the current operation.

delete_directory_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_directory::delete_directory_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to delete the directory.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A pplx::task object that that represents the current operation.

delete_directory_if_exists() [1/2]

bool azure::storage::cloud_file_directory::delete_directory_if_exists ( )

inline

Deletes the directory if it does exist.

Returns

true if the directory did exist and was deleted; otherwise false.

delete_directory_if_exists() [2/2]

bool azure::storage::cloud_file_directory::delete_directory_if_exists ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Deletes the directory if it does exist.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

true if the directory did exist and was deleted; otherwise false.

delete_directory_if_exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file_directory::delete_directory_if_exists_async ( )

inline

Intitiates an asynchronous operation to delete the directory if it does exist.

Returns

A pplx::task object that that represents the current operation.

delete_directory_if_exists_async() [2/2]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_file_directory::delete_directory_if_exists_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to delete the directory if it does exist.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A pplx::task object that that represents the current operation.

download_attributes() [1/2]

void azure::storage::cloud_file_directory::download_attributes ( )

inline

Retrieves the directory's attributes.

download_attributes() [2/2]

void azure::storage::cloud_file_directory::download_attributes ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Retrieves the directory's attributes.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

download_attributes_async() [1/2]

pplx::task<void> azure::storage::cloud_file_directory::download_attributes_async ( )

inline

Intitiates an asynchronous operation to retrieve the directory's attributes.

Returns

A pplx::task object that that represents the current operation.

download_attributes_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_directory::download_attributes_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to retrieve the directory's attributes.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A pplx::task object that that represents the current operation.

exists() [1/2]

bool azure::storage::cloud_file_directory::exists ( )

inline

Checks existence of the directory.

Returns

true if the directory exists.

exists() [2/2]

bool azure::storage::cloud_file_directory::exists ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Checks existence of the directory.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

true if the directory exists.

exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file_directory::exists_async ( )

inline

Intitiates an asynchronous operation to check existence of the directory.

Returns

A pplx::task object that that represents the current operation.

exists_async() [2/2]

pplx::task<bool> azure::storage::cloud_file_directory::exists_async ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Intitiates an asynchronous operation to check existence of the directory.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A pplx::task object that that represents the current operation.

get_file_reference()

WASTORAGE_API cloud_file azure::storage::cloud_file_directory::get_file_reference

(

const utility::string_t &

name

)

const

Gets a reference to a file.

Parameters

name	The name of the file.

Returns

A reference to an azure::storage::cloud_file.

get_parent_directory_reference()

WASTORAGE_API cloud_file_directory azure::storage::cloud_file_directory::get_parent_directory_reference

(

)

const

Gets a reference to parent directory.

Returns

A reference to an azure::storage::cloud_file_directory.

get_parent_share_reference()

cloud_file_share azure::storage::cloud_file_directory::get_parent_share_reference ( ) const

inline

Gets a reference to parent share.

Returns

A reference to an azure::storage::cloud_file_share.

get_subdirectory_reference()

cloud_file_directory azure::storage::cloud_file_directory::get_subdirectory_reference ( utility::string_t  name ) const

inline

Gets a reference to a sub directory.

Parameters

name	The name of the directory.

Returns

A reference to an azure::storage::cloud_file_directory.

list_files_and_directories() [1/6]

list_file_and_diretory_result_iterator azure::storage::cloud_file_directory::list_files_and_directories ( ) const

inline

Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items.

Returns

An azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories() [2/6]

list_file_and_diretory_result_iterator azure::storage::cloud_file_directory::list_files_and_directories ( const utility::string_t &  prefix ) const

inline

Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items.

Parameters

prefix

The file/directory name prefix.

Returns

An azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories() [3/6]

list_file_and_diretory_result_iterator azure::storage::cloud_file_directory::list_files_and_directories ( int64_t  max_results ) const

inline

Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items.

Parameters

max_results

A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned.

Returns

An azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories() [4/6]

list_file_and_diretory_result_iterator azure::storage::cloud_file_directory::list_files_and_directories ( const utility::string_t &  prefix, int64_t  max_results  ) const

inline

Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items.

Parameters

prefix	The file/directory name prefix.
max_results	A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned.

Returns

An azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories() [5/6]

list_file_and_diretory_result_iterator azure::storage::cloud_file_directory::list_files_and_directories ( int64_t  max_results, const file_request_options &  options, operation_context  context  ) const

inline

Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items.

Parameters

max_results	A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories() [6/6]

WASTORAGE_API list_file_and_diretory_result_iterator azure::storage::cloud_file_directory::list_files_and_directories	(	const utility::string_t &	prefix,
		int64_t	max_results,
		const file_request_options &	options,
		operation_context	context
	)		const

Returns an azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items.

Parameters

prefix	The file/directory name prefix.
max_results	A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::list_file_and_diretory_result_iterator that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories_segmented() [1/4]

list_file_and_directory_result_segment azure::storage::cloud_file_directory::list_files_and_directories_segmented ( const continuation_token &  token ) const

inline

Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

token

A continuation token returned by a previous listing operation.

Returns

An azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories_segmented() [2/4]

list_file_and_directory_result_segment azure::storage::cloud_file_directory::list_files_and_directories_segmented ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

prefix	The file/directory name prefix.
token	A continuation token returned by a previous listing operation.

Returns

An azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories_segmented() [3/4]

list_file_and_directory_result_segment azure::storage::cloud_file_directory::list_files_and_directories_segmented ( int64_t  max_results, const continuation_token &  token, const file_request_options &  options, operation_context  context  ) const

inline

Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

max_results

A non-negative integer value that indicates the maximum number of results to be returned. Parameters token A continuation token returned by a previous listing operation. options An azure::storage::file_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation. Returns An azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories_segmented() [4/4]

list_file_and_directory_result_segment azure::storage::cloud_file_directory::list_files_and_directories_segmented ( const utility::string_t &  prefix, int64_t  max_results, const continuation_token &  token, const file_request_options &  options, operation_context  context  ) const

inline

Returns a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

prefix

The file/directory name prefix.

max_results

A non-negative integer value that indicates the maximum number of results to be returned. Parameters token A continuation token returned by a previous listing operation. options An azure::storage::file_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation. Returns An azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items in the the directory.

list_files_and_directories_segmented_async() [1/4]

pplx::task<list_file_and_directory_result_segment> azure::storage::cloud_file_directory::list_files_and_directories_segmented_async ( const continuation_token &  token ) const

inline

Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

token

A continuation token returned by a previous listing operation.

Returns

A pplx::task object of type azure::storage::list_file_and_directory_result_segment that represents the current operation.

list_files_and_directories_segmented_async() [2/4]

pplx::task<list_file_and_directory_result_segment> azure::storage::cloud_file_directory::list_files_and_directories_segmented_async ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

prefix	The file/directory name prefix.
token	A continuation token returned by a previous listing operation.

Returns

A pplx::task object of type azure::storage::list_file_and_directory_result_segment that represents the current operation.

list_files_and_directories_segmented_async() [3/4]

pplx::task<list_file_and_directory_result_segment> azure::storage::cloud_file_directory::list_files_and_directories_segmented_async ( int64_t  max_results, const continuation_token &  token, const file_request_options &  options, operation_context  context  ) const

inline

Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

max_results

A non-negative integer value that indicates the maximum number of results to be returned. Parameters token A continuation token returned by a previous listing operation. options An azure::storage::file_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation. Returns A pplx::task object of type azure::storage::list_file_and_directory_result_segment that represents the current operation.

list_files_and_directories_segmented_async() [4/4]

WASTORAGE_API pplx::task<list_file_and_directory_result_segment> azure::storage::cloud_file_directory::list_files_and_directories_segmented_async	(	const utility::string_t &	prefix,
		int64_t	max_results,
		const continuation_token &	token,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to return a result segment azure::storage::list_file_and_directory_result_segment that can be used to to lazily enumerate a collection of file or directory items.

Parameters

prefix

The file/directory name prefix.

max_results

A non-negative integer value that indicates the maximum number of results to be returned. Parameters token A continuation token returned by a previous listing operation. options An azure::storage::file_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation. Returns A pplx::task object of type azure::storage::list_file_and_directory_result_segment that represents the current operation.

metadata() [1/2]

cloud_metadata& azure::storage::cloud_file_directory::metadata ( )

inline

Gets the directory's system metadata.

Returns

The directory's metadata.

metadata() [2/2]

const cloud_metadata& azure::storage::cloud_file_directory::metadata ( ) const

inline

Gets the directory's system metadata.

Returns

The directory's metadata.

name()

const utility::string_t& azure::storage::cloud_file_directory::name ( ) const

inline

Gets the directory's name.

Returns

The directory's name.

properties() [1/2]

cloud_file_directory_properties& azure::storage::cloud_file_directory::properties ( )

inline

Gets the directory's system properties.

Returns

The directory's properties.

properties() [2/2]

const cloud_file_directory_properties& azure::storage::cloud_file_directory::properties ( ) const

inline

Gets the directory's system properties.

Returns

The directory's properties.

service_client()

const cloud_file_client& azure::storage::cloud_file_directory::service_client ( ) const

inline

Gets the azure::storage::cloud_file_client object that represents the File service.

Returns

A client object that specifies the File service endpoint.

upload_metadata() [1/2]

void azure::storage::cloud_file_directory::upload_metadata ( ) const

inline

Uploads the directory's metadata.

upload_metadata() [2/2]

void azure::storage::cloud_file_directory::upload_metadata ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Uploads the directory's metadata.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

upload_metadata_async() [1/2]

pplx::task<void> azure::storage::cloud_file_directory::upload_metadata_async ( ) const

inline

Intitiates an asynchronous operation to upload the directory's metadata.

Returns

A pplx::task object that that represents the current operation.

upload_metadata_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_directory::upload_metadata_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to upload the directory's metadata.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

A pplx::task object that that represents the current operation.

upload_properties() [1/2]

void azure::storage::cloud_file_directory::upload_properties ( ) const

inline

Updates the directory's properties.

upload_properties() [2/2]

void azure::storage::cloud_file_directory::upload_properties ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Updates the directory's properties.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

upload_properties_async() [1/2]

pplx::task<void> azure::storage::cloud_file_directory::upload_properties_async ( ) const

inline

Intitiates an asynchronous operation to update the directory's properties.

Returns

A pplx::task object that that represents the current operation.

upload_properties_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_directory::upload_properties_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to update the directory's properties.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the operation.
options	An azure::storage::file_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that that represents the current operation.

uri()

const storage_uri& azure::storage::cloud_file_directory::uri ( ) const

inline

Gets the directory URI for all locations.

Returns

An azure::storage::storage_uri containing the directory URI for all locations.