ShareFileClient.ForceCloseAllHandles(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.17.1

Package:: Azure.Storage.Files.Shares v12.18.0-beta.2

Source:: ShareFileClient.cs

Source:: ShareFileClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The ForceCloseAllHandles(CancellationToken) operation closes all handles opened on a file at the service.

This API is intended to be used alongside GetHandlesAsync(CancellationToken) to force close handles that block operations. These handles may have leaked or been lost track of by SMB clients. The API has client-side impact on the handle being closed, including user visible errors due to failed attempts to read or write files. This API is not intended for use as a replacement or alternative for SMB close.

For more information, see Force Close Handles.

public virtual Azure.Storage.Files.Shares.Models.CloseHandlesResult ForceCloseAllHandles (System.Threading.CancellationToken cancellationToken = default);

abstract member ForceCloseAllHandles : System.Threading.CancellationToken -> Azure.Storage.Files.Shares.Models.CloseHandlesResult
override this.ForceCloseAllHandles : System.Threading.CancellationToken -> Azure.Storage.Files.Shares.Models.CloseHandlesResult

Public Overridable Function ForceCloseAllHandles (Optional cancellationToken As CancellationToken = Nothing) As CloseHandlesResult

Parameters

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

CloseHandlesResult

A CloseHandlesResult describing the status of the ForceCloseAllHandles(CancellationToken) operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to