Public Member Functions
	ShareDirectoryClient (const std::string &shareDirectoryUrl, std::shared_ptr< StorageSharedKeyCredential > credential, const ShareClientOptions &options=ShareClientOptions())
	Initialize a new instance of ShareDirectoryClient using shared key authentication. More...

	ShareDirectoryClient (const std::string &shareDirectoryUrl, const ShareClientOptions &options=ShareClientOptions())
	Initialize a new instance of ShareDirectoryClient using anonymous access or shared access signature. More...

std::string	GetUrl () const
	Gets the directory's primary URL endpoint. More...

ShareDirectoryClient	GetSubdirectoryClient (const std::string &subdirectoryName) const
	Create a ShareDirectoryClient that's a sub directory of the current ShareDirectoryClient. More...

ShareFileClient	GetFileClient (const std::string &fileName) const
	Create a ShareFileClient from current ShareDirectoryClient. More...

ShareDirectoryClient	WithShareSnapshot (const std::string &shareSnapshot) const
	Initializes a new instance of the ShareDirectoryClient class with an identical URL source but the specified share snapshot timestamp. More...

Azure::Response< Models::CreateDirectoryResult >	Create (const CreateDirectoryOptions &options=CreateDirectoryOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Creates the directory. More...

Azure::Response< Models::CreateDirectoryResult >	CreateIfNotExists (const CreateDirectoryOptions &options=CreateDirectoryOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Creates the directory if it does not exist. More...

Azure::Response< Models::DeleteDirectoryResult >	Delete (const DeleteDirectoryOptions &options=DeleteDirectoryOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Deletes the directory. More...

Azure::Response< Models::DeleteDirectoryResult >	DeleteIfExists (const DeleteDirectoryOptions &options=DeleteDirectoryOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Deletes the directory if it exists. More...

Azure::Response< Models::DirectoryProperties >	GetProperties (const GetDirectoryPropertiesOptions &options=GetDirectoryPropertiesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Gets the properties of the directory. More...

Azure::Response< Models::SetDirectoryPropertiesResult >	SetProperties (Models::FileSmbProperties smbProperties, const SetDirectoryPropertiesOptions &options=SetDirectoryPropertiesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets the properties of the directory. More...

Azure::Response< Models::SetDirectoryMetadataResult >	SetMetadata (Storage::Metadata metadata, const SetDirectoryMetadataOptions &options=SetDirectoryMetadataOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets the metadata of the directory. More...

ListFilesAndDirectoriesPagedResponse	ListFilesAndDirectories (const ListFilesAndDirectoriesOptions &options=ListFilesAndDirectoriesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Returns a sequence of files and subdirectories in this directory. Enumerating the files and directories may make multiple requests to the service while fetching all the values. More...

ListDirectoryHandlesPagedResponse	ListHandles (const ListDirectoryHandlesOptions &options=ListDirectoryHandlesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Returns a sequence of the open handles on a directory or a file. Enumerating the handles may make multiple requests to the service while fetching all the values. More...

Azure::Response< Models::ForceCloseDirectoryHandleResult >	ForceCloseHandle (const std::string &handleId, const ForceCloseDirectoryHandleOptions &options=ForceCloseDirectoryHandleOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Closes a handle opened on a directory at the service. More...

ForceCloseAllDirectoryHandlesPagedResponse	ForceCloseAllHandles (const ForceCloseAllDirectoryHandlesOptions &options=ForceCloseAllDirectoryHandlesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Closes all handles opened on a directory at the service. Optionally supports recursively closing handles on subresources. More...

Static Public Member Functions
static ShareDirectoryClient	CreateFromConnectionString (const std::string &connectionString, const std::string &shareName, const std::string &directoryName, const ShareClientOptions &options=ShareClientOptions())
	Create A ShareDirectoryClient from connection string to manage a File Share Directory resource. More...

Friends
class	ShareClient

Constructor & Destructor Documentation

◆ ShareDirectoryClient() [1/2]

Azure::Storage::Files::Shares::ShareDirectoryClient::ShareDirectoryClient	(	const std::string &	shareDirectoryUrl,
		std::shared_ptr< StorageSharedKeyCredential >	credential,
		const ShareClientOptions &	options = `ShareClientOptions()`
	)

explicit

Parameters

shareDirectoryUrl	The URL of the directory this client's request targets.
credential	The shared key credential used to initialize the client.
options	Optional parameters used to initialize the client.

◆ ShareDirectoryClient() [2/2]

Azure::Storage::Files::Shares::ShareDirectoryClient::ShareDirectoryClient	(	const std::string &	shareDirectoryUrl,
		const ShareClientOptions &	options = `ShareClientOptions()`
	)

explicit

Parameters

shareDirectoryUrl	The URL of the directory this client's request targets.
options	Optional parameters used to initialize the client.

Member Function Documentation

◆ Create()

Azure::Response< Models::CreateDirectoryResult > Azure::Storage::Files::Shares::ShareDirectoryClient::Create	(	const CreateDirectoryOptions &	options = `CreateDirectoryOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to create this directory.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::CreateDirectoryResult> containing the information returned when creating the directory.

◆ CreateFromConnectionString()

ShareDirectoryClient Azure::Storage::Files::Shares::ShareDirectoryClient::CreateFromConnectionString	(	const std::string &	connectionString,
		const std::string &	shareName,
		const std::string &	directoryName,
		const ShareClientOptions &	options = `ShareClientOptions()`
	)

static

Parameters

connectionString	Azure Storage connection string.
shareName	The name of a file share.
directoryName	The name of a directory.
options	Optional parameters used to initialize the client.

Returns: ShareClient The client that can be used to manage a share resource.

◆ CreateIfNotExists()

Azure::Response< Models::CreateDirectoryResult > Azure::Storage::Files::Shares::ShareDirectoryClient::CreateIfNotExists	(	const CreateDirectoryOptions &	options = `CreateDirectoryOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to create this directory.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::CreateDirectoryResult> containing the information returned when creating the directory if successfully created.

◆ Delete()

Azure::Response< Models::DeleteDirectoryResult > Azure::Storage::Files::Shares::ShareDirectoryClient::Delete	(	const DeleteDirectoryOptions &	options = `DeleteDirectoryOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to delete this directory.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::DeleteDirectoryResult> containing the information returned when deleting the directory. Currently empty but preserved for future usage.

◆ DeleteIfExists()

Azure::Response< Models::DeleteDirectoryResult > Azure::Storage::Files::Shares::ShareDirectoryClient::DeleteIfExists	(	const DeleteDirectoryOptions &	options = `DeleteDirectoryOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to delete this directory.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::DeleteDirectoryResult> containing the information returned when deleting the directory. Currently empty but preserved for future usage. Only when the delete operation if successful, the returned information other than 'Deleted' is valid.

◆ ForceCloseAllHandles()

ForceCloseAllDirectoryHandlesPagedResponse Azure::Storage::Files::Shares::ShareDirectoryClient::ForceCloseAllHandles	(	const ForceCloseAllDirectoryHandlesOptions &	options = `ForceCloseAllDirectoryHandlesOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to close all this directory's open handles.
context	Context for cancelling long running operations.

Returns: ForceCloseAllDirectoryHandlesPagedResponse containing the information of the closed handles.

◆ ForceCloseHandle()

Azure::Response< Models::ForceCloseDirectoryHandleResult > Azure::Storage::Files::Shares::ShareDirectoryClient::ForceCloseHandle	(	const std::string &	handleId,
		const ForceCloseDirectoryHandleOptions &	options = `ForceCloseDirectoryHandleOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

handleId	The ID of the handle to be closed.
options	Optional parameters to close one of this directory's open handles.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::ForceCloseDirectoryHandleResult> containing the information of the closed handle. Current empty but preserved for future usage.

◆ GetFileClient()

ShareFileClient Azure::Storage::Files::Shares::ShareDirectoryClient::GetFileClient ( const std::string & fileName ) const

Parameters

fileName The name of the file.

Returns: ShareFileClient A file client that can be used to manage a share file resource.

◆ GetProperties()

Azure::Response< Models::DirectoryProperties > Azure::Storage::Files::Shares::ShareDirectoryClient::GetProperties	(	const GetDirectoryPropertiesOptions &	options = `GetDirectoryPropertiesOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to get this directory's properties.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::DirectoryProperties> containing the properties of the directory returned from the server.

◆ GetSubdirectoryClient()

ShareDirectoryClient Azure::Storage::Files::Shares::ShareDirectoryClient::GetSubdirectoryClient ( const std::string & subdirectoryName ) const

Parameters

subdirectoryName The name of the subdirectory.

Returns: ShareDirectoryClient A directory client that can be used to manage a share directory resource.

◆ GetUrl()

std::string Azure::Storage::Files::Shares::ShareDirectoryClient::GetUrl ( ) const

inline

Returns: The directory's primary URL endpoint.

◆ ListFilesAndDirectories()

ListFilesAndDirectoriesPagedResponse Azure::Storage::Files::Shares::ShareDirectoryClient::ListFilesAndDirectories	(	const ListFilesAndDirectoriesOptions &	options = `ListFilesAndDirectoriesOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to list the files and directories under this directory.
context	Context for cancelling long running operations.

Returns: ListFilesAndDirectoriesPagedResponse describing the items in the directory.

◆ ListHandles()

ListDirectoryHandlesPagedResponse Azure::Storage::Files::Shares::ShareDirectoryClient::ListHandles	(	const ListDirectoryHandlesOptions &	options = `ListDirectoryHandlesOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to list this directory's open handles.
context	Context for cancelling long running operations.

Returns: ListDirectoryHandlesPagedResponse describing the handles in the directory.

◆ SetMetadata()

Azure::Response< Models::SetDirectoryMetadataResult > Azure::Storage::Files::Shares::ShareDirectoryClient::SetMetadata	(	Storage::Metadata	metadata,
		const SetDirectoryMetadataOptions &	options = `SetDirectoryMetadataOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

metadata	User-defined metadata to be stored with the directory. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
options	Optional parameters to set this directory's metadata.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::SetDirectoryMetadataResult> containing the information of the directory returned from the server.

◆ SetProperties()

Azure::Response< Models::SetDirectoryPropertiesResult > Azure::Storage::Files::Shares::ShareDirectoryClient::SetProperties	(	Models::FileSmbProperties	smbProperties,
		const SetDirectoryPropertiesOptions &	options = `SetDirectoryPropertiesOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

smbProperties	The SMB properties to be set to the directory.
options	Optional parameters to set this directory's properties.
context	Context for cancelling long running operations.

Returns: Azure::Response<Models::SetDirectoryPropertiesResult> containing the properties of the directory returned from the server.

◆ WithShareSnapshot()

ShareDirectoryClient Azure::Storage::Files::Shares::ShareDirectoryClient::WithShareSnapshot ( const std::string & shareSnapshot ) const

Parameters

shareSnapshot The snapshot identifier for a share snapshot.

Returns: A new ShareDirectoryClient instance.

Remarks: Pass empty string to remove the snapshot returning the directory client without specifying the share snapshot.

The documentation for this class was generated from the following files:

inc/azure/storage/files/shares/share_directory_client.hpp
src/share_directory_client.cpp

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

◆ ShareDirectoryClient() [1/2]

◆ ShareDirectoryClient() [2/2]

Member Function Documentation

◆ Create()

◆ CreateFromConnectionString()

◆ CreateIfNotExists()

◆ Delete()

◆ DeleteIfExists()

◆ ForceCloseAllHandles()

◆ ForceCloseHandle()

◆ GetFileClient()

◆ GetProperties()

◆ GetSubdirectoryClient()

◆ GetUrl()

◆ ListFilesAndDirectories()

◆ ListHandles()

◆ SetMetadata()

◆ SetProperties()

◆ WithShareSnapshot()