CloudFileClient.ListSharesSegmentedAsync Method (String, ShareListingDetails, Nullable, FileContinuationToken, FileRequestOptions, OperationContext)

Windows Runtime Azure Storage Client Library

Returns a result segment containing a collection of shares whose names begin with the specified prefix.

Namespace: Microsoft.WindowsAzure.Storage.File
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Usage

Visual Basic
Dim instance As CloudFileClient
Dim prefix As String
Dim detailsIncluded As ShareListingDetails
Dim maxResults As Nullable(Of Integer)
Dim currentToken As FileContinuationToken
Dim options As FileRequestOptions
Dim operationContext As OperationContext
Dim returnValue As IAsyncOperation(Of ShareResultSegment)

returnValue = instance.ListSharesSegmentedAsync(prefix, detailsIncluded, maxResults, currentToken, options, operationContext)

Syntax

Visual Basic
Public Function ListSharesSegmentedAsync ( _
	prefix As String, _
	detailsIncluded As ShareListingDetails, _
	maxResults As Nullable(Of Integer), _
	currentToken As FileContinuationToken, _
	options As FileRequestOptions, _
	operationContext As OperationContext _
) As IAsyncOperation(Of ShareResultSegment)
C#
public IAsyncOperation<ShareResultSegment> ListSharesSegmentedAsync (
	string prefix,
	ShareListingDetails detailsIncluded,
	Nullable<int> maxResults,
	FileContinuationToken currentToken,
	FileRequestOptions options,
	OperationContext operationContext
)
C++
public:
IAsyncOperation<ShareResultSegment^>^ ListSharesSegmentedAsync (
	String^ prefix, 
	ShareListingDetails detailsIncluded, 
	Nullable<int> maxResults, 
	FileContinuationToken^ currentToken, 
	FileRequestOptions^ options, 
	OperationContext^ operationContext
)
J#
public IAsyncOperation<ShareResultSegment> ListSharesSegmentedAsync (
	String prefix, 
	ShareListingDetails detailsIncluded, 
	Nullable<int> maxResults, 
	FileContinuationToken currentToken, 
	FileRequestOptions options, 
	OperationContext operationContext
)
JScript
public function ListSharesSegmentedAsync (
	prefix : String, 
	detailsIncluded : ShareListingDetails, 
	maxResults : Nullable<int>, 
	currentToken : FileContinuationToken, 
	options : FileRequestOptions, 
	operationContext : OperationContext
) : IAsyncOperation<ShareResultSegment>

Parameters

prefix

The share name prefix.

detailsIncluded

A value that indicates whether to return share metadata with the listing.

maxResults

A non-negative integer value that indicates the maximum number of results to be returned in the result segment, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.

currentToken

A continuation token returned by a previous listing operation.

Return Value

A result segment of shares.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

See Also