A class for Windows Azure file. More...

Public Member Functions
	cloud_file ()
	Initializes a new instance of the azure::storage::cloud_file class. More...

WASTORAGE_API	cloud_file (storage_uri uri)
	Initializes a new instance of the azure::storage::cloud_file class. More...

WASTORAGE_API	cloud_file (storage_uri uri, storage_credentials credentials)
	Initializes a new instance of the azure::storage::cloud_file class. More...

WASTORAGE_API	cloud_file (utility::string_t name, cloud_file_directory directory)
	Initializes a new instance of the azure::storage::cloud_file class. More...

WASTORAGE_API	cloud_file (utility::string_t name, cloud_file_directory directory, cloud_file_properties properties, cloud_metadata metadata, azure::storage::copy_state copy_state)
	Initializes a new instance of the azure::storage::cloud_file class. More...

void	create (int64_t length)
	Creates the file and specifies the size of the file. More...

void	create (int64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context)
	Creates the file and specifies the size of the file. More...

pplx::task< void >	create_async (int64_t length)
	Intitiates an asynchronous operation to create the file and specifies the size of the file. More...

WASTORAGE_API pplx::task< void >	create_async (int64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the file and specifies the size of the file. More...

bool	create_if_not_exists (int64_t length)
	Creates the file if it does not already exist. More...

bool	create_if_not_exists (int64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context)
	Creates the file if it does not already exist. More...

pplx::task< bool >	create_if_not_exists_async (int64_t length)
	Intitiates an asynchronous operation to create the file if it does not already exist and specify the size of the file. More...

WASTORAGE_API pplx::task< bool >	create_if_not_exists_async (int64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the file if it does not already exist and specify the size of the file. More...

void	delete_file ()
	Deletes the file. More...

void	delete_file (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Deletes the file. More...

pplx::task< void >	delete_file_async ()
	Intitiates an asynchronous operation to delete the file. More...

WASTORAGE_API pplx::task< void >	delete_file_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the file. More...

bool	delete_file_if_exists ()
	Deletes the file if it already exists. More...

bool	delete_file_if_exists (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Deletes the file if it already exists. More...

pplx::task< bool >	delete_file_if_exists_async ()
	Intitiates an asynchronous operation to delete the file if it already exists. More...

WASTORAGE_API pplx::task< bool >	delete_file_if_exists_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the file if it already exists. More...

bool	exists () const
	Checks existence of the file. More...

bool	exists (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Checks existence of the file. More...

pplx::task< bool >	exists_async () const
	Intitiates an asynchronous operation to check the existence of the file. More...

pplx::task< bool >	exists_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to check the existence of the file. More...

void	download_attributes ()
	Retrieves the file's attributes. More...

void	download_attributes (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Retrieves the file's attributes. More...

pplx::task< void >	download_attributes_async ()
	Intitiates an asynchronous operation to retrieve the file'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 file's attributes. More...

void	upload_properties () const
	Updates the file's properties. More...

void	upload_properties (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Updates the file's properties. More...

pplx::task< void >	upload_properties_async () const
	Intitiates an asynchronous operation to update the file'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 file's properties. More...

void	upload_metadata () const
	Updates the file's metadata. More...

void	upload_metadata (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Updates the file's metadata. More...

pplx::task< void >	upload_metadata_async () const
	Intitiates an asynchronous operation to update the file'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 update the file's metadata. More...

utility::string_t	start_copy (const web::http::uri &source)
	Begins an operation to copy a file's contents, properties, and metadata to a new file. More...

utility::string_t	start_copy (const web::http::uri &source, const file_access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context)
	Begins an operation to copy a file's contents, properties, and metadata to a new file. More...

utility::string_t	start_copy (const web::http::uri &source, const access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context)
	Begins an operation to copy a blob's contents, properties, and metadata to a new file. More...

pplx::task< utility::string_t >	start_copy_async (const web::http::uri &source)
	Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file. More...

WASTORAGE_API pplx::task< utility::string_t >	start_copy_async (const web::http::uri &source, const file_access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file. More...

WASTORAGE_API pplx::task< utility::string_t >	start_copy_async (const web::http::uri &source, const access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new file. More...

utility::string_t	start_copy (const cloud_file &source)
	Begins an operation to copy a file's contents, properties, and metadata to a new file. More...

utility::string_t	start_copy (const cloud_file &source, const file_access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context)
	Begins an operation to copy a file's contents, properties, and metadata to a new file. More...

pplx::task< utility::string_t >	start_copy_async (const cloud_file &source)
	Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file. More...

WASTORAGE_API pplx::task< utility::string_t >	start_copy_async (const cloud_file &source, const file_access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file. More...

utility::string_t	start_copy (const cloud_blob &source)
	Begins an operation to copy a blob's contents, properties, and metadata to a new file. More...

utility::string_t	start_copy (const cloud_blob &source, const access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context)
	Begins an operation to copy a blob's contents, properties, and metadata to a new file. More...

WASTORAGE_API pplx::task< utility::string_t >	start_copy_async (const cloud_blob &source) const
	Intitiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new file. More...

WASTORAGE_API pplx::task< utility::string_t >	start_copy_async (const cloud_blob &source, const access_condition &source_condition, const file_access_condition &dest_condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new file. More...

void	abort_copy (const utility::string_t &copy_id) const
	Aborts an ongoing file copy operation. More...

void	abort_copy (const utility::string_t &copy_id, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Aborts an ongoing file copy operation. More...

pplx::task< void >	abort_copy_async (const utility::string_t &copy_id) const
	Intitiates an asynchronous operation to abort an ongoing file copy operation. More...

WASTORAGE_API pplx::task< void >	abort_copy_async (const utility::string_t &copy_id, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to abort an ongoing file copy operation. More...

std::vector< file_range >	list_ranges () const
	Gets a collection of valid file ranges. More...

std::vector< file_range >	list_ranges (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Gets a collection of valid file ranges. More...

pplx::task< std::vector< file_range > >	list_ranges_async () const
	Intitiates an asynchronous operation to get a collection of valid file ranges. More...

pplx::task< std::vector< file_range > >	list_ranges_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to get a collection of valid file ranges. More...

std::vector< file_range >	list_ranges (utility::size64_t start_offset) const
	Gets a collection of valid file ranges and their starting bytes. More...

std::vector< file_range >	list_ranges (utility::size64_t start_offset, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Gets a collection of valid file ranges and their starting bytes. More...

pplx::task< std::vector< file_range > >	list_ranges_async (utility::size64_t start_offset) const
	Intitiates an asynchronous operation to get a collection of valid file ranges and their starting bytes. More...

pplx::task< std::vector< file_range > >	list_ranges_async (utility::size64_t start_offset, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to get a collection of valid file ranges and their starting bytes. More...

std::vector< file_range >	list_ranges (utility::size64_t start_offset, utility::size64_t length) const
	Gets a collection of valid file ranges and their starting and ending bytes. More...

std::vector< file_range >	list_ranges (utility::size64_t start_offset, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Gets a collection of valid file ranges and their starting and ending bytes. More...

pplx::task< std::vector< file_range > >	list_ranges_async (utility::size64_t start_offset, utility::size64_t length) const
	Intitiates an asynchronous operation to get a collection of valid file ranges and their starting and ending bytes. More...

WASTORAGE_API pplx::task< std::vector< file_range > >	list_ranges_async (utility::size64_t start_offset, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to get a collection of valid file ranges and their starting and ending bytes. More...

void	clear_range (utility::size64_t start_offset, utility::size64_t length) const
	Clears range from a file. More...

void	clear_range (utility::size64_t start_offset, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Clears range from a file. More...

pplx::task< void >	clear_range_async (utility::size64_t start_offset, utility::size64_t length) const
	Intitiates an asynchronous operation to clear range from a file. More...

WASTORAGE_API pplx::task< void >	clear_range_async (utility::size64_t start_offset, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to clear range from a file. More...

void	write_range (Concurrency::streams::istream stream, int64_t start_offset, utility::string_t content_md5) const
	Writes range to a file. More...

void	write_range (Concurrency::streams::istream stream, int64_t start_offset, utility::string_t content_md5, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Writes range to a file. More...

pplx::task< void >	write_range_async (Concurrency::streams::istream stream, int64_t start_offset, utility::string_t content_md5) const
	Intitiates an asynchronous operation to write range to a file. More...

WASTORAGE_API pplx::task< void >	write_range_async (Concurrency::streams::istream stream, int64_t start_offset, const utility::string_t &content_md5, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to write range to a file. More...

void	download_to_stream (concurrency::streams::ostream target) const
	Downloads the contents of a file to a stream. More...

void	download_to_stream (concurrency::streams::ostream target, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Downloads the contents of a file to a stream. More...

pplx::task< void >	download_to_stream_async (concurrency::streams::ostream target) const
	Intitiates an asynchronous operation to download the contents of a file to a stream. More...

pplx::task< void >	download_to_stream_async (concurrency::streams::ostream target, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to download the contents of a file to a stream. More...

void	download_range_to_stream (concurrency::streams::ostream target, utility::size64_t offset, utility::size64_t length) const
	Downloads a range of bytes in a file to a stream. More...

void	download_range_to_stream (concurrency::streams::ostream target, utility::size64_t offset, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Downloads a range of bytes in a file to a stream. More...

pplx::task< void >	download_range_to_stream_async (concurrency::streams::ostream target, int64_t offset, int64_t length) const
	Intitiates an asynchronous operation to download a range of bytes in a file to a stream. More...

WASTORAGE_API pplx::task< void >	download_range_to_stream_async (concurrency::streams::ostream target, utility::size64_t start_offset, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to download a range of bytes in a file to a stream. More...

void	download_to_file (const utility::string_t &path) const
	Downloads the contents of a file to a file. More...

void	download_to_file (const utility::string_t &path, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Downloads the contents of a file to a file. More...

pplx::task< void >	download_to_file_async (const utility::string_t &path) const
	Intitiates an asynchronous operation to download the contents of a file to a file. More...

WASTORAGE_API pplx::task< void >	download_to_file_async (const utility::string_t &path, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to download the contents of a file to a file. More...

utility::string_t	download_text () const
	Downloads the contents of a file as text. More...

utility::string_t	download_text (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Downloads the contents of a file as text. More...

pplx::task< utility::string_t >	download_text_async () const
	Intitiates an asynchronous operation to download the contents of a file as text. More...

WASTORAGE_API pplx::task< utility::string_t >	download_text_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to download the contents of a file as text. More...

concurrency::streams::ostream	open_write () const
	Opens a stream for writing to the file. More...

concurrency::streams::ostream	open_write (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Opens a stream for writing to the file. More...

pplx::task< concurrency::streams::ostream >	open_write_async () const
	Intitiates an asynchronous operation to open a stream for writing to the file. More...

WASTORAGE_API pplx::task< concurrency::streams::ostream >	open_write_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to open a stream for writing to the file. More...

concurrency::streams::ostream	open_write (utility::size64_t length) const
	Opens a stream for writing to the file. More...

concurrency::streams::ostream	open_write (utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Opens a stream for writing to the file. More...

pplx::task< concurrency::streams::ostream >	open_write_async (utility::size64_t length) const
	Intitiates an asynchronous operation to open a stream for writing to the file. More...

WASTORAGE_API pplx::task< concurrency::streams::ostream >	open_write_async (utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to open a stream for writing to the file. More...

void	upload_from_stream (concurrency::streams::istream stream) const
	Uploads the file from stream. More...

void	upload_from_stream (concurrency::streams::istream stream, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Uploads the file from stream. More...

pplx::task< void >	upload_from_stream_async (concurrency::streams::istream stream) const
	Intitiates an asynchronous operation to upload the file from stream. More...

pplx::task< void >	upload_from_stream_async (concurrency::streams::istream stream, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to upload the file from stream. More...

void	upload_from_stream (concurrency::streams::istream stream, utility::size64_t length) const
	Uploads the file from stream. More...

void	upload_from_stream (concurrency::streams::istream stream, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Uploads the file from stream. More...

pplx::task< void >	upload_from_stream_async (concurrency::streams::istream stream, utility::size64_t length) const
	Intitiates an asynchronous operation to upload the file from stream. More...

WASTORAGE_API pplx::task< void >	upload_from_stream_async (concurrency::streams::istream stream, utility::size64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to upload the file from stream. More...

void	upload_from_file (const utility::string_t &path) const
	Uploads the file from local file. More...

void	upload_from_file (const utility::string_t &path, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Uploads the file from local file. More...

pplx::task< void >	upload_from_file_async (const utility::string_t &path) const
	Intitiates an asynchronous operation to upload the file from local file. More...

WASTORAGE_API pplx::task< void >	upload_from_file_async (const utility::string_t &path, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to upload the file from local file. More...

void	upload_text (const utility::string_t &text) const
	Uploads the file from text. More...

void	upload_text (const utility::string_t &text, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Uploads the file from text. More...

pplx::task< void >	upload_text_async (const utility::string_t &text) const
	Intitiates an asynchronous operation to upload the file from text. More...

WASTORAGE_API pplx::task< void >	upload_text_async (const utility::string_t &text, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to upload the file from text. More...

void	resize (int64_t length) const
	Resize the file. More...

void	resize (int64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Resize the file. More...

pplx::task< void >	resize_async (int64_t length) const
	Intitiates an asynchronous operation to resize the file. More...

WASTORAGE_API pplx::task< void >	resize_async (int64_t length, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to resize the file. More...

utility::string_t	get_shared_access_signature (const file_shared_access_policy &policy) const
	Returns a shared access signature for the file. More...

WASTORAGE_API utility::string_t	get_shared_access_signature (const file_shared_access_policy &policy, const utility::string_t &stored_policy_identifier)
	Returns a shared access signature for the file. More...

WASTORAGE_API utility::string_t	get_shared_access_signature (const file_shared_access_policy &policy, const utility::string_t &stored_policy_identifier, const cloud_file_shared_access_headers &headers) const
	Returns a shared access signature for the file. More...

const cloud_file_client &	service_client () const
	Gets the azure::storage::cloud_file_client object that represents the File service. More...

cloud_file_share	get_parent_share_reference () const
	Gets the azure::storage::cloud_file_client object that represents the File service. More...

cloud_file_directory	get_parent_directory_reference () const
	Gets the azure::storage::cloud_file_client object that represents the File service. More...

const utility::string_t	path () const
	Gets the file's path. More...

utility::string_t &	name ()
	Gets the file's name. More...

const utility::string_t &	name () const
	Gets the file's name. More...

const storage_uri &	uri () const
	Gets the file URI for all locations. More...

const cloud_metadata &	metadata () const
	Gets the file's system metadata. More...

cloud_metadata &	metadata ()
	Gets the file's system metadata. More...

const cloud_file_properties &	properties () const
	Gets the file's system properties. More...

cloud_file_properties &	properties ()
	Gets the file's system properties. More...

const azure::storage::copy_state &	copy_state () const
	Gets the file's system properties. More...

azure::storage::copy_state &	copy_state ()
	Gets the file's system properties. More...

utility::string_t	acquire_lease (const utility::string_t &proposed_lease_id) const
	Acquires a lease on the file. More...

utility::string_t	acquire_lease (const utility::string_t &proposed_lease_id, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Acquires a lease on the file. More...

pplx::task< utility::string_t >	acquire_lease_async (const utility::string_t &proposed_lease_id) const
	Initiates an asynchronous operation to acquire a lease on the file. More...

pplx::task< utility::string_t >	acquire_lease_async (const utility::string_t &proposed_lease_id, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Initiates an asynchronous operation to acquire a lease on the file. More...

WASTORAGE_API pplx::task< utility::string_t >	acquire_lease_async (const utility::string_t &proposed_lease_id, const file_access_condition &condition, const file_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to acquire a lease on the file. More...

utility::string_t	change_lease (const utility::string_t &proposed_lease_id, const file_access_condition &condition) const
	Changes the lease ID on the file. More...

utility::string_t	change_lease (const utility::string_t &proposed_lease_id, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Changes the lease ID on the file. More...

pplx::task< utility::string_t >	change_lease_async (const utility::string_t &proposed_lease_id, const file_access_condition &condition) const
	Initiates an asynchronous operation to change the lease ID on the file. More...

pplx::task< utility::string_t >	change_lease_async (const utility::string_t &proposed_lease_id, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Initiates an asynchronous operation to change the lease ID on the file. More...

WASTORAGE_API pplx::task< utility::string_t >	change_lease_async (const utility::string_t &proposed_lease_id, const file_access_condition &condition, const file_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to change the lease ID on the file. More...

void	release_lease (const file_access_condition &condition) const
	Releases the lease on the file. More...

void	release_lease (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Releases the lease on the file. More...

pplx::task< void >	release_lease_async (const file_access_condition &condition) const
	Initiates an asynchronous operation to release the lease on the file. More...

pplx::task< void >	release_lease_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Initiates an asynchronous operation to release the lease on the file. More...

WASTORAGE_API pplx::task< void >	release_lease_async (const file_access_condition &condition, const file_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to release the lease on the file. More...

void	break_lease () const
	Breaks the current lease on the file. More...

void	break_lease (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Breaks the current lease on the file. More...

pplx::task< void >	break_lease_async () const
	Initiates an asynchronous operation to break the current lease on the file. More...

pplx::task< void >	break_lease_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Initiates an asynchronous operation to break the current lease on the file. More...

WASTORAGE_API pplx::task< void >	break_lease_async (const file_access_condition &condition, const file_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to break the current lease on the file. More...

Detailed Description

A class for Windows Azure file.

Constructor & Destructor Documentation

◆ cloud_file() [1/5]

azure::storage::cloud_file::cloud_file ( )

inline

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

◆ cloud_file() [2/5]

WASTORAGE_API azure::storage::cloud_file::cloud_file ( storage_uri uri )

explicit

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

Parameters

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

◆ cloud_file() [3/5]

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

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

Parameters

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

◆ cloud_file() [4/5]

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

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

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the file for all locations.
share	The File directory it blongs to.

◆ cloud_file() [5/5]

WASTORAGE_API azure::storage::cloud_file::cloud_file	(	utility::string_t	name,
		cloud_file_directory	directory,
		cloud_file_properties	properties,
		cloud_metadata	metadata,
		azure::storage::copy_state	copy_state
	)

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

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the file for all locations.
share	The File directory it blongs to.
properties	A set of properties for the file.
metadata	User-defined metadata for the file.
copy_state	the state of the most recent or pending copy operation.

Member Function Documentation

◆ abort_copy() [1/2]

void azure::storage::cloud_file::abort_copy ( const utility::string_t & copy_id ) const

inline

Aborts an ongoing file copy operation.

Parameters

copy_id A string identifying the copy operation.

◆ abort_copy() [2/2]

void azure::storage::cloud_file::abort_copy	(	const utility::string_t &	copy_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Aborts an ongoing file copy operation.

Parameters

copy_id	A string identifying the copy operation.
condition	An azure::storage::file_request_options 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.

◆ abort_copy_async() [1/2]

pplx::task<void> azure::storage::cloud_file::abort_copy_async ( const utility::string_t & copy_id ) const

inline

Intitiates an asynchronous operation to abort an ongoing file copy operation.

Parameters

copy_id A string identifying the copy operation.

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

◆ abort_copy_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::abort_copy_async	(	const utility::string_t &	copy_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to abort an ongoing file copy operation.

Parameters

copy_id	A string identifying the copy operation.
condition	An azure::storage::file_request_options 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 represents the current operation.

◆ acquire_lease() [1/2]

utility::string_t azure::storage::cloud_file::acquire_lease ( const utility::string_t & proposed_lease_id ) const

inline

Acquires a lease on the file.

Parameters

proposed_lease_id A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.

Returns: A string containing the lease ID.

◆ acquire_lease() [2/2]

utility::string_t azure::storage::cloud_file::acquire_lease	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Acquires a lease on the file.

Parameters

proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
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 string containing the lease ID.

◆ acquire_lease_async() [1/3]

pplx::task<utility::string_t> azure::storage::cloud_file::acquire_lease_async ( const utility::string_t & proposed_lease_id ) const

inline

Initiates an asynchronous operation to acquire a lease on the file.

Parameters

proposed_lease_id A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

◆ acquire_lease_async() [2/3]

pplx::task<utility::string_t> azure::storage::cloud_file::acquire_lease_async	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Initiates an asynchronous operation to acquire a lease on the file.

Parameters

proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
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 of type utility::string_t that represents the current operation.

◆ acquire_lease_async() [3/3]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::acquire_lease_async	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to acquire a lease on the file.

Parameters

proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
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.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

◆ break_lease() [1/2]

void azure::storage::cloud_file::break_lease ( ) const

inline

Breaks the current lease on the file.

◆ break_lease() [2/2]

void azure::storage::cloud_file::break_lease	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Breaks the current lease on the file.

Parameters

condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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.

◆ break_lease_async() [1/3]

pplx::task<void> azure::storage::cloud_file::break_lease_async ( ) const

inline

Initiates an asynchronous operation to break the current lease on the file.

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

◆ break_lease_async() [2/3]

pplx::task<void> azure::storage::cloud_file::break_lease_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Initiates an asynchronous operation to break the current lease on the file.

Parameters

condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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 represents the current operation.

◆ break_lease_async() [3/3]

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

Initiates an asynchronous operation to break the current lease on the file.

Parameters

condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

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

◆ change_lease() [1/2]

utility::string_t azure::storage::cloud_file::change_lease	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition
	)		const

inline

Changes the lease ID on the file.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.

Returns: The new lease ID.

◆ change_lease() [2/2]

utility::string_t azure::storage::cloud_file::change_lease	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Changes the lease ID on the file.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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: The new lease ID.

◆ change_lease_async() [1/3]

pplx::task<utility::string_t> azure::storage::cloud_file::change_lease_async	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition
	)		const

inline

Initiates an asynchronous operation to change the lease ID on the file.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

◆ change_lease_async() [2/3]

pplx::task<utility::string_t> azure::storage::cloud_file::change_lease_async	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Initiates an asynchronous operation to change the lease ID on the file.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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 utility::string_t that represents the current operation.

◆ change_lease_async() [3/3]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::change_lease_async	(	const utility::string_t &	proposed_lease_id,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to change the lease ID on the file.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

◆ clear_range() [1/2]

void azure::storage::cloud_file::clear_range	(	utility::size64_t	start_offset,
		utility::size64_t	length
	)		const

inline

Clears range from a file.

Parameters

start_offset	The offset at which to begin clearing ranges, in bytes. The offset must be a multiple of 512.
length	The length of the data range to be cleared, in bytes. The length must be a multiple of 512.

◆ clear_range() [2/2]

void azure::storage::cloud_file::clear_range	(	utility::size64_t	start_offset,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Clears range from a file.

Parameters

start_offset	The offset at which to begin clearing ranges, in bytes. The offset must be a multiple of 512.
length	The length of the data range to be cleared, in bytes. The length must be a multiple of 512.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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.

◆ clear_range_async() [1/2]

pplx::task<void> azure::storage::cloud_file::clear_range_async	(	utility::size64_t	start_offset,
		utility::size64_t	length
	)		const

inline

Intitiates an asynchronous operation to clear range from a file.

Parameters

start_offset	The offset at which to begin clearing ranges, in bytes. The offset must be a multiple of 512.
length	The length of the data range to be cleared, in bytes. The length must be a multiple of 512.

◆ clear_range_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::clear_range_async	(	utility::size64_t	start_offset,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to clear range from a file.

Parameters

start_offset	The offset at which to begin clearing ranges, in bytes. The offset must be a multiple of 512.
length	The length of the data range to be cleared, in bytes. The length must be a multiple of 512.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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.

◆ copy_state() [1/2]

const azure::storage::copy_state& azure::storage::cloud_file::copy_state ( ) const

inline

Gets the file's system properties.

Returns: The file's properties.

◆ copy_state() [2/2]

azure::storage::copy_state& azure::storage::cloud_file::copy_state ( )

inline

Gets the file's system properties.

Returns: The file's properties.

◆ create() [1/2]

void azure::storage::cloud_file::create ( int64_t length )

inline

Creates the file and specifies the size of the file.

Parameters

length An utility::size64_t value that specifies the size of the file.

◆ create() [2/2]

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

inline

Creates the file and specifies the size of the file.

Parameters

length	An utility::size64_t value that specifies the size of the file.
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::create_async ( int64_t length )

inline

Intitiates an asynchronous operation to create the file and specifies the size of the file.

Parameters

length An utility::size64_t value that specifies the size of the file.

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

◆ create_async() [2/2]

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

Intitiates an asynchronous operation to create the file and specifies the size of the file.

Parameters

length	An utility::size64_t value that specifies the size of the file.
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 represents the current operation.

◆ create_if_not_exists() [1/2]

bool azure::storage::cloud_file::create_if_not_exists ( int64_t length )

inline

Creates the file if it does not already exist.

Parameters

max_size An utility::size64_t value that specifies the size of the file.

Returns: true if the file did not already exist and was created; otherwise false.

◆ create_if_not_exists() [2/2]

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

inline

Creates the file if it does not already exist.

Parameters

max_size	An utility::size64_t value that specifies the size of the file.
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 file did not already exist and was created; otherwise false.

◆ create_if_not_exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file::create_if_not_exists_async ( int64_t length )

inline

Intitiates an asynchronous operation to create the file if it does not already exist and specify the size of the file.

Parameters

max_size An utility::size64_t value that specifies the size of the file.

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

◆ create_if_not_exists_async() [2/2]

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

Intitiates an asynchronous operation to create the file if it does not already exist and specify the size of the file.

Parameters

max_size	An utility::size64_t value that specifies the size of the file.
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 represents the current operation.

◆ delete_file() [1/2]

void azure::storage::cloud_file::delete_file ( )

inline

Deletes the file.

◆ delete_file() [2/2]

void azure::storage::cloud_file::delete_file	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

inline

Deletes the file.

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.

◆ delete_file_async() [1/2]

pplx::task<void> azure::storage::cloud_file::delete_file_async ( )

inline

Intitiates an asynchronous operation to delete the file.

◆ delete_file_async() [2/2]

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

Intitiates an asynchronous operation to delete the file.

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.

◆ delete_file_if_exists() [1/2]

bool azure::storage::cloud_file::delete_file_if_exists ( )

inline

Deletes the file if it already exists.

Returns: true if the file did not already exist and was deleted; otherwise false.

◆ delete_file_if_exists() [2/2]

bool azure::storage::cloud_file::delete_file_if_exists	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

inline

Deletes the file if it already exists.

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: true if the file did not already exist and was deleted; otherwise false.

◆ delete_file_if_exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file::delete_file_if_exists_async ( )

inline

Intitiates an asynchronous operation to delete the file if it already exists.

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

◆ delete_file_if_exists_async() [2/2]

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

Intitiates an asynchronous operation to delete the file if it already exists.

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 represents the current operation.

◆ download_attributes() [1/2]

void azure::storage::cloud_file::download_attributes ( )

inline

Retrieves the file's attributes.

◆ download_attributes() [2/2]

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

inline

Retrieves the file'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.

◆ download_attributes_async() [1/2]

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

inline

Intitiates an asynchronous operation to retrieve the file'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::download_attributes_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to retrieve the file'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.

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

◆ download_range_to_stream() [1/2]

void azure::storage::cloud_file::download_range_to_stream	(	concurrency::streams::ostream	target,
		utility::size64_t	offset,
		utility::size64_t	length
	)		const

inline

Downloads a range of bytes in a file to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the file, in bytes.
length	The length of the data to download from the file, in bytes.

◆ download_range_to_stream() [2/2]

void azure::storage::cloud_file::download_range_to_stream	(	concurrency::streams::ostream	target,
		utility::size64_t	offset,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Downloads a range of bytes in a file to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the file, in bytes.
length	The length of the data to download from the file, in bytes.
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.

◆ download_range_to_stream_async() [1/2]

pplx::task<void> azure::storage::cloud_file::download_range_to_stream_async	(	concurrency::streams::ostream	target,
		int64_t	offset,
		int64_t	length
	)		const

inline

Intitiates an asynchronous operation to download a range of bytes in a file to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the file, in bytes.
length	The length of the data to download from the file, in bytes.

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

◆ download_range_to_stream_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::download_range_to_stream_async	(	concurrency::streams::ostream	target,
		utility::size64_t	start_offset,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to download a range of bytes in a file to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the file, in bytes.
length	The length of the data to download from the file, in bytes.
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 represents the current operation.

◆ download_text() [1/2]

utility::string_t azure::storage::cloud_file::download_text ( ) const

inline

Downloads the contents of a file as text.

Returns: The contents of the file, as a string.

◆ download_text() [2/2]

utility::string_t azure::storage::cloud_file::download_text	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Downloads the contents of a file as text.

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: The contents of the file, as a string.

◆ download_text_async() [1/2]

pplx::task<utility::string_t> azure::storage::cloud_file::download_text_async ( ) const

inline

Intitiates an asynchronous operation to download the contents of a file as text.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

◆ download_text_async() [2/2]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::download_text_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to download the contents of a file as text.

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 of type utility::string_t that represents the current operation.

◆ download_to_file() [1/2]

void azure::storage::cloud_file::download_to_file ( const utility::string_t & path ) const

inline

Downloads the contents of a file to a file.

Parameters

path	The target file.

◆ download_to_file() [2/2]

void azure::storage::cloud_file::download_to_file	(	const utility::string_t &	path,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Downloads the contents of a file to a file.

Parameters

path	The target file.
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.

◆ download_to_file_async() [1/2]

pplx::task<void> azure::storage::cloud_file::download_to_file_async ( const utility::string_t & path ) const

inline

Intitiates an asynchronous operation to download the contents of a file to a file.

Parameters

path	The target file.

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

◆ download_to_file_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::download_to_file_async	(	const utility::string_t &	path,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to download the contents of a file to a file.

Parameters

path	The target file.
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 represents the current operation.

◆ download_to_stream() [1/2]

void azure::storage::cloud_file::download_to_stream ( concurrency::streams::ostream target ) const

inline

Downloads the contents of a file to a stream.

Parameters

target The target stream.

◆ download_to_stream() [2/2]

void azure::storage::cloud_file::download_to_stream	(	concurrency::streams::ostream	target,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Downloads the contents of a file to a stream.

Parameters

target	The target stream.
condition	An azure::storage::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.

◆ download_to_stream_async() [1/2]

pplx::task<void> azure::storage::cloud_file::download_to_stream_async ( concurrency::streams::ostream target ) const

inline

Intitiates an asynchronous operation to download the contents of a file to a stream.

Parameters

target The target stream.

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

◆ download_to_stream_async() [2/2]

pplx::task<void> azure::storage::cloud_file::download_to_stream_async	(	concurrency::streams::ostream	target,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Intitiates an asynchronous operation to download the contents of a file to a stream.

Parameters

target	The target stream.
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 represents the current operation.

◆ exists() [1/2]

bool azure::storage::cloud_file::exists ( ) const

inline

Checks existence of the file.

Returns: true if the file exists.

◆ exists() [2/2]

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

inline

Checks existence of the file.

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: true if the file exists.

◆ exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file::exists_async ( ) const

inline

Intitiates an asynchronous operation to check the existence of the file.

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

◆ exists_async() [2/2]

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

inline

Intitiates an asynchronous operation to check the existence of the file.

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.

◆ get_parent_directory_reference()

cloud_file_directory azure::storage::cloud_file::get_parent_directory_reference ( ) 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.

◆ get_parent_share_reference()

cloud_file_share azure::storage::cloud_file::get_parent_share_reference ( ) 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.

◆ get_shared_access_signature() [1/3]

utility::string_t azure::storage::cloud_file::get_shared_access_signature ( const file_shared_access_policy & policy ) const

inline

Returns a shared access signature for the file.

Parameters

policy The access policy for the shared access signature.

Returns: A string containing a shared access signature.

◆ get_shared_access_signature() [2/3]

WASTORAGE_API utility::string_t azure::storage::cloud_file::get_shared_access_signature	(	const file_shared_access_policy &	policy,
		const utility::string_t &	stored_policy_identifier
	)

inline

Returns a shared access signature for the file.

Parameters

policy	The access policy for the shared access signature.
stored_policy_identifier	A share-level access policy.

Returns: A string containing a shared access signature.

◆ get_shared_access_signature() [3/3]

WASTORAGE_API utility::string_t azure::storage::cloud_file::get_shared_access_signature	(	const file_shared_access_policy &	policy,
		const utility::string_t &	stored_policy_identifier,
		const cloud_file_shared_access_headers &	headers
	)		const

Returns a shared access signature for the file.

Parameters

policy	The access policy for the shared access signature.
stored_policy_identifier	A share-level access policy.
headers	The optional header values to set for a file returned with this SAS.

Returns: A string containing a shared access signature.

◆ list_ranges() [1/6]

std::vector<file_range> azure::storage::cloud_file::list_ranges ( ) const

inline

Gets a collection of valid file ranges.

Returns: An enumerable collection of file ranges.

◆ list_ranges() [2/6]

std::vector<file_range> azure::storage::cloud_file::list_ranges	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Gets a collection of valid file ranges.

Parameters

condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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 enumerable collection of file ranges.

◆ list_ranges() [3/6]

std::vector<file_range> azure::storage::cloud_file::list_ranges ( utility::size64_t start_offset ) const

inline

Gets a collection of valid file ranges and their starting bytes.

Parameters

offset The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512. If the value sets to be max of size64_t, it will attampt to list all ranges.

Returns: An enumerable collection of file ranges.

◆ list_ranges() [4/6]

std::vector<file_range> azure::storage::cloud_file::list_ranges	(	utility::size64_t	start_offset,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Gets a collection of valid file ranges and their starting bytes.

Parameters

offset	The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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 enumerable collection of file ranges.

◆ list_ranges() [5/6]

std::vector<file_range> azure::storage::cloud_file::list_ranges	(	utility::size64_t	start_offset,
		utility::size64_t	length
	)		const

inline

Gets a collection of valid file ranges and their starting and ending bytes.

Parameters

offset	The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
length	The length of the data range over which to list file ranges, in bytes. Must be a multiple of 512.

Returns: An enumerable collection of file ranges.

◆ list_ranges() [6/6]

std::vector<file_range> azure::storage::cloud_file::list_ranges	(	utility::size64_t	start_offset,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Gets a collection of valid file ranges and their starting and ending bytes.

Parameters

offset	The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
length	The length of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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 enumerable collection of file ranges.

◆ list_ranges_async() [1/6]

pplx::task<std::vector<file_range> > azure::storage::cloud_file::list_ranges_async ( ) const

inline

Intitiates an asynchronous operation to get a collection of valid file ranges.

Returns: A pplx::task object of type std::vector, of type azure::storage::file_range, that represents the current operation.

◆ list_ranges_async() [2/6]

pplx::task<std::vector<file_range> > azure::storage::cloud_file::list_ranges_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Intitiates an asynchronous operation to get a collection of valid file ranges.

Parameters

condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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 std::vector, of type azure::storage::file_range, that represents the current operation.

◆ list_ranges_async() [3/6]

pplx::task<std::vector<file_range> > azure::storage::cloud_file::list_ranges_async ( utility::size64_t start_offset ) const

inline

Intitiates an asynchronous operation to get a collection of valid file ranges and their starting bytes.

Parameters

offset The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512.

Returns: A pplx::task object of type std::vector, of type azure::storage::file_range, that represents the current operation.

◆ list_ranges_async() [4/6]

pplx::task<std::vector<file_range> > azure::storage::cloud_file::list_ranges_async	(	utility::size64_t	start_offset,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Intitiates an asynchronous operation to get a collection of valid file ranges and their starting bytes.

Parameters

offset	The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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 std::vector, of type azure::storage::file_range, that represents the current operation.

◆ list_ranges_async() [5/6]

pplx::task<std::vector<file_range> > azure::storage::cloud_file::list_ranges_async	(	utility::size64_t	start_offset,
		utility::size64_t	length
	)		const

inline

Intitiates an asynchronous operation to get a collection of valid file ranges and their starting and ending bytes.

Parameters

offset	The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
length	The length of the data range over which to list file ranges, in bytes. Must be a multiple of 512.

Returns: A pplx::task object of type std::vector, of type azure::storage::file_range, that represents the current operation.

◆ list_ranges_async() [6/6]

WASTORAGE_API pplx::task<std::vector<file_range> > azure::storage::cloud_file::list_ranges_async	(	utility::size64_t	start_offset,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to get a collection of valid file ranges and their starting and ending bytes.

Parameters

offset	The starting offset of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
length	The length of the data range over which to list file ranges, in bytes. Must be a multiple of 512.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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 std::vector, of type azure::storage::file_range, that represents the current operation.

◆ metadata() [1/2]

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

inline

Gets the file's system metadata.

Returns: The file's metadata.

◆ metadata() [2/2]

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

inline

Gets the file's system metadata.

Returns: The file's metadata.

◆ name() [1/2]

utility::string_t& azure::storage::cloud_file::name ( )

inline

Gets the file's name.

Returns: The file's name.

◆ name() [2/2]

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

inline

Gets the file's name.

Returns: The file's name.

◆ open_write() [1/4]

concurrency::streams::ostream azure::storage::cloud_file::open_write ( ) const

inline

Opens a stream for writing to the file.

Returns: A stream to be used for writing to the file.

◆ open_write() [2/4]

concurrency::streams::ostream azure::storage::cloud_file::open_write	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Opens a stream for writing to the file.

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 stream to be used for writing to the file.

◆ open_write() [3/4]

concurrency::streams::ostream azure::storage::cloud_file::open_write ( utility::size64_t length ) const

inline

Opens a stream for writing to the file.

Parameters

length The length of the file, in bytes.

Returns: A stream to be used for writing to the file.

◆ open_write() [4/4]

concurrency::streams::ostream azure::storage::cloud_file::open_write	(	utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Opens a stream for writing to the file.

Parameters

length	The length of the file, in bytes.
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 stream to be used for writing to the file.

◆ open_write_async() [1/4]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_file::open_write_async ( ) const

inline

Intitiates an asynchronous operation to open a stream for writing to the file.

Returns: A stream to be used for writing to the file.

◆ open_write_async() [2/4]

WASTORAGE_API pplx::task<concurrency::streams::ostream> azure::storage::cloud_file::open_write_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to open a stream for writing to the file.

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 stream to be used for writing to the file.

◆ open_write_async() [3/4]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_file::open_write_async ( utility::size64_t length ) const

inline

Intitiates an asynchronous operation to open a stream for writing to the file.

Parameters

length The length of the file, in bytes.

Returns: A stream to be used for writing to the file.

◆ open_write_async() [4/4]

WASTORAGE_API pplx::task<concurrency::streams::ostream> azure::storage::cloud_file::open_write_async	(	utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to open a stream for writing to the file.

Parameters

length	The length of the file, in bytes.
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 stream to be used for writing to the file.

◆ path()

const utility::string_t azure::storage::cloud_file::path ( ) const

Gets the file's path.

Returns: The file's path.

◆ properties() [1/2]

const cloud_file_properties& azure::storage::cloud_file::properties ( ) const

inline

Gets the file's system properties.

Returns: The file's properties.

◆ properties() [2/2]

cloud_file_properties& azure::storage::cloud_file::properties ( )

inline

Gets the file's system properties.

Returns: The file's properties.

◆ release_lease() [1/2]

void azure::storage::cloud_file::release_lease ( const file_access_condition & condition ) const

inline

Releases the lease on the file.

Parameters

condition An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.

◆ release_lease() [2/2]

void azure::storage::cloud_file::release_lease	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Releases the lease on the file.

Parameters

condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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.

◆ release_lease_async() [1/3]

pplx::task<void> azure::storage::cloud_file::release_lease_async ( const file_access_condition & condition ) const

inline

Initiates an asynchronous operation to release the lease on the file.

Parameters

condition An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.

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

◆ release_lease_async() [2/3]

pplx::task<void> azure::storage::cloud_file::release_lease_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Initiates an asynchronous operation to release the lease on the file.

Parameters

condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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 represents the current operation.

◆ release_lease_async() [3/3]

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

Initiates an asynchronous operation to release the lease on the file.

Parameters

condition	An azure::storage::file_access_condition object that represents the access conditions for the file, including a required lease ID.
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.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

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

◆ resize() [1/2]

void azure::storage::cloud_file::resize ( int64_t length ) const

inline

Resize the file.

Parameters

quota The size to apply to the file.

◆ resize() [2/2]

void azure::storage::cloud_file::resize	(	int64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Resize the file.

Parameters

quota	The size to apply to the file.
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.

◆ resize_async() [1/2]

pplx::task<void> azure::storage::cloud_file::resize_async ( int64_t length ) const

inline

Intitiates an asynchronous operation to resize the file.

Parameters

quota The size to apply to the file.

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

◆ resize_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::resize_async	(	int64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to resize the file.

Parameters

quota	The size to apply to the file.
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.

◆ service_client()

const cloud_file_client& azure::storage::cloud_file::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.

◆ start_copy() [1/7]

utility::string_t azure::storage::cloud_file::start_copy ( const web::http::uri & source )

inline

Begins an operation to copy a file's contents, properties, and metadata to a new file.

Parameters

source The URI of a source file.

Returns: The copy ID associated with the copy operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy() [2/7]

utility::string_t azure::storage::cloud_file::start_copy	(	const web::http::uri &	source,
		const file_access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)

inline

Begins an operation to copy a file's contents, properties, and metadata to a new file.

Parameters

source	The URI of a source file.
source_condition	An object that represents the azure::storage::file_access_condition for the source file.
destination_condition	An object that represents the azure::storage::file_access_condition for the destination file.
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: The copy ID associated with the copy operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy() [3/7]

utility::string_t azure::storage::cloud_file::start_copy	(	const web::http::uri &	source,
		const access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)

inline

Begins an operation to copy a blob's contents, properties, and metadata to a new file.

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::file_access_condition for the source file.
destination_condition	An object that represents the azure::storage::file_access_condition for the destination file.
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: The copy ID associated with the copy operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy() [4/7]

utility::string_t azure::storage::cloud_file::start_copy ( const cloud_file & source )

inline

Begins an operation to copy a file's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source file.

Returns: The copy ID associated with the copy operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy() [5/7]

utility::string_t azure::storage::cloud_file::start_copy	(	const cloud_file &	source,
		const file_access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)

inline

Begins an operation to copy a file's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source file.

Parameters

source_condition	An object that represents the file_access_condition for the source file.
dest_condition	An object that represents the file_access_condition for the destination file.
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: The copy ID associated with the copy operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy() [6/7]

utility::string_t azure::storage::cloud_file::start_copy ( const cloud_blob & source )

inline

Begins an operation to copy a blob's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source blob.

Returns: The copy ID associated with the copy operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy() [7/7]

utility::string_t azure::storage::cloud_file::start_copy	(	const cloud_blob &	source,
		const access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)

inline

Begins an operation to copy a blob's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source blob.

Parameters

source_condition	An object that represents the access_condition for the source blob.
dest_condition	An object that represents the file_access_condition for the destination file.
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: The copy ID associated with the copy operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [1/7]

pplx::task<utility::string_t> azure::storage::cloud_file::start_copy_async ( const web::http::uri & source )

inline

Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file.

Parameters

source The URI of a source file.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [2/7]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::start_copy_async	(	const web::http::uri &	source,
		const file_access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file.

Parameters

source	The URI of a source file.
source_condition	An object that represents the azure::storage::file_access_condition for the source file.
destination_condition	An object that represents the azure::storage::file_access_condition for the destination file.
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 utility::string_t that represents the current operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [3/7]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::start_copy_async	(	const web::http::uri &	source,
		const access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new file.

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::file_access_condition for the source file.
destination_condition	An object that represents the azure::storage::file_access_condition for the destination file.
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 utility::string_t that represents the current operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [4/7]

pplx::task<utility::string_t> azure::storage::cloud_file::start_copy_async ( const cloud_file & source )

inline

Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source file.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [5/7]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::start_copy_async	(	const cloud_file &	source,
		const file_access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source file.

Parameters

source_condition	An object that represents the azure::storage::file_access_condition for the source file.
destination_condition	An object that represents the azure::storage::file_access_condition for the destination file.
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 utility::string_t that represents the current operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [6/7]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::start_copy_async ( const cloud_blob & source ) const

Intitiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source blob.

Returns: A pplx::task object of type utility::string_t that represents the current operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [7/7]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file::start_copy_async	(	const cloud_blob &	source,
		const access_condition &	source_condition,
		const file_access_condition &	dest_condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new file.

Parameters

source

An object that represents the for the source blob.

Parameters

source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::file_access_condition for the destination file.
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 utility::string_t that represents the current operation.

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ upload_from_file() [1/2]

void azure::storage::cloud_file::upload_from_file ( const utility::string_t & path ) const

inline

Uploads the file from local file.

Parameters

path	The local file providing the file content.

◆ upload_from_file() [2/2]

void azure::storage::cloud_file::upload_from_file	(	const utility::string_t &	path,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Uploads the file from local file.

Parameters

path	The local file providing the file content.
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_from_file_async() [1/2]

pplx::task<void> azure::storage::cloud_file::upload_from_file_async ( const utility::string_t & path ) const

inline

Intitiates an asynchronous operation to upload the file from local file.

Parameters

path	The local file providing the file content.

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

◆ upload_from_file_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::upload_from_file_async	(	const utility::string_t &	path,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to upload the file from local file.

Parameters

path	The local file providing the file content.
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.

◆ upload_from_stream() [1/4]

void azure::storage::cloud_file::upload_from_stream ( concurrency::streams::istream stream ) const

inline

Uploads the file from stream.

Parameters

stream The stream providing the file content.

◆ upload_from_stream() [2/4]

void azure::storage::cloud_file::upload_from_stream	(	concurrency::streams::istream	stream,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Uploads the file from stream.

Parameters

stream	The stream providing the file content.
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_from_stream() [3/4]

void azure::storage::cloud_file::upload_from_stream	(	concurrency::streams::istream	stream,
		utility::size64_t	length
	)		const

inline

Uploads the file from stream.

Parameters

stream	The stream providing the file content.
length	The length of the file, in bytes.

◆ upload_from_stream() [4/4]

void azure::storage::cloud_file::upload_from_stream	(	concurrency::streams::istream	stream,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Uploads the file from stream.

Parameters

stream	The stream providing the file content.
length	The length of the file, in bytes.
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_from_stream_async() [1/4]

pplx::task<void> azure::storage::cloud_file::upload_from_stream_async ( concurrency::streams::istream stream ) const

inline

Intitiates an asynchronous operation to upload the file from stream.

Parameters

stream The stream providing the file content.

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

◆ upload_from_stream_async() [2/4]

pplx::task<void> azure::storage::cloud_file::upload_from_stream_async	(	concurrency::streams::istream	stream,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Intitiates an asynchronous operation to upload the file from stream.

Parameters

stream	The stream providing the file content.
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.

◆ upload_from_stream_async() [3/4]

pplx::task<void> azure::storage::cloud_file::upload_from_stream_async	(	concurrency::streams::istream	stream,
		utility::size64_t	length
	)		const

inline

Intitiates an asynchronous operation to upload the file from stream.

Parameters

stream	The stream providing the file content.
length	The length of the file, in bytes.

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

◆ upload_from_stream_async() [4/4]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::upload_from_stream_async	(	concurrency::streams::istream	stream,
		utility::size64_t	length,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to upload the file from stream.

Parameters

stream	The stream providing the file content.
length	The length of the file, in bytes.
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.

◆ upload_metadata() [1/2]

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

inline

Updates the file's metadata.

◆ upload_metadata() [2/2]

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

inline

Updates the file'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.

◆ upload_metadata_async() [1/2]

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

inline

Intitiates an asynchronous operation to update the file'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::upload_metadata_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to update the file'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.

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

◆ upload_properties() [1/2]

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

inline

Updates the file's properties.

◆ upload_properties() [2/2]

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

inline

Updates the file'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::upload_properties_async ( ) const

inline

Intitiates an asynchronous operation to update the file'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::upload_properties_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to update the file'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.

◆ upload_text() [1/2]

void azure::storage::cloud_file::upload_text ( const utility::string_t & text ) const

inline

Uploads the file from text.

Parameters

text	The text providing the file content.

◆ upload_text() [2/2]

void azure::storage::cloud_file::upload_text	(	const utility::string_t &	text,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Uploads the file from text.

Parameters

text	The text providing the file content.
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_text_async() [1/2]

pplx::task<void> azure::storage::cloud_file::upload_text_async ( const utility::string_t & text ) const

inline

Intitiates an asynchronous operation to upload the file from text.

Parameters

text	The text providing the file content.

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

◆ upload_text_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::upload_text_async	(	const utility::string_t &	text,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to upload the file from text.

Parameters

text	The text providing the file content.
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::uri ( ) const

inline

Gets the file URI for all locations.

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

◆ write_range() [1/2]

void azure::storage::cloud_file::write_range	(	Concurrency::streams::istream	stream,
		int64_t	start_offset,
		utility::string_t	content_md5
	)		const

inline

Writes range to a file.

Parameters

stream	A stream providing the file range data.
start_offset	The offset at which to begin writing, in bytes. The offset must be a multiple of 512.
content_md5	An optional hash value that will be used to set the Content-MD5 property on the blob. May be an empty string.

◆ write_range() [2/2]

void azure::storage::cloud_file::write_range	(	Concurrency::streams::istream	stream,
		int64_t	start_offset,
		utility::string_t	content_md5,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

inline

Writes range to a file.

Parameters

stream	A stream providing the file range data.
start_offset	The offset at which to begin writing, in bytes. The offset must be a multiple of 512.
content_md5	An optional hash value that will be used to set the Content-MD5 property on the blob. May be an empty string.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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.

◆ write_range_async() [1/2]

pplx::task<void> azure::storage::cloud_file::write_range_async	(	Concurrency::streams::istream	stream,
		int64_t	start_offset,
		utility::string_t	content_md5
	)		const

inline

Intitiates an asynchronous operation to write range to a file.

Parameters

stream	A stream providing the file range data.
start_offset	The offset at which to begin writing, in bytes. The offset must be a multiple of 512.
content_md5	An optional hash value that will be used to set the Content-MD5 property on the blob. May be an empty string.

◆ write_range_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file::write_range_async	(	Concurrency::streams::istream	stream,
		int64_t	start_offset,
		const utility::string_t &	content_md5,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to write range to a file.

Parameters

stream	A stream providing the file range data.
start_offset	The offset at which to begin writing, in bytes. The offset must be a multiple of 512.
content_md5	An optional hash value that will be used to set the Content-MD5 property on the blob. May be an empty string.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ cloud_file() [1/5]

◆ cloud_file() [2/5]

◆ cloud_file() [3/5]

◆ cloud_file() [4/5]

◆ cloud_file() [5/5]

Member Function Documentation

◆ abort_copy() [1/2]

◆ abort_copy() [2/2]

◆ abort_copy_async() [1/2]

◆ abort_copy_async() [2/2]

◆ acquire_lease() [1/2]

◆ acquire_lease() [2/2]

◆ acquire_lease_async() [1/3]

◆ acquire_lease_async() [2/3]

◆ acquire_lease_async() [3/3]

◆ break_lease() [1/2]

◆ break_lease() [2/2]

◆ break_lease_async() [1/3]

◆ break_lease_async() [2/3]

◆ break_lease_async() [3/3]

◆ change_lease() [1/2]

◆ change_lease() [2/2]

◆ change_lease_async() [1/3]

◆ change_lease_async() [2/3]

◆ change_lease_async() [3/3]

◆ clear_range() [1/2]

◆ clear_range() [2/2]

◆ clear_range_async() [1/2]

◆ clear_range_async() [2/2]

◆ copy_state() [1/2]

◆ copy_state() [2/2]

◆ create() [1/2]

◆ create() [2/2]

◆ create_async() [1/2]

◆ create_async() [2/2]

◆ create_if_not_exists() [1/2]

◆ create_if_not_exists() [2/2]

◆ create_if_not_exists_async() [1/2]

◆ create_if_not_exists_async() [2/2]

◆ delete_file() [1/2]

◆ delete_file() [2/2]

◆ delete_file_async() [1/2]

◆ delete_file_async() [2/2]

◆ delete_file_if_exists() [1/2]

◆ delete_file_if_exists() [2/2]

◆ delete_file_if_exists_async() [1/2]

◆ delete_file_if_exists_async() [2/2]

◆ download_attributes() [1/2]

◆ download_attributes() [2/2]

◆ download_attributes_async() [1/2]

◆ download_attributes_async() [2/2]

◆ download_range_to_stream() [1/2]

◆ download_range_to_stream() [2/2]

◆ download_range_to_stream_async() [1/2]

◆ download_range_to_stream_async() [2/2]

◆ download_text() [1/2]

◆ download_text() [2/2]

◆ download_text_async() [1/2]

◆ download_text_async() [2/2]

◆ download_to_file() [1/2]

◆ download_to_file() [2/2]

◆ download_to_file_async() [1/2]

◆ download_to_file_async() [2/2]

◆ download_to_stream() [1/2]

◆ download_to_stream() [2/2]

◆ download_to_stream_async() [1/2]

◆ download_to_stream_async() [2/2]

◆ exists() [1/2]

◆ exists() [2/2]

◆ exists_async() [1/2]

◆ exists_async() [2/2]

◆ get_parent_directory_reference()

◆ get_parent_share_reference()

◆ get_shared_access_signature() [1/3]

◆ get_shared_access_signature() [2/3]

◆ get_shared_access_signature() [3/3]

◆ list_ranges() [1/6]