IFolderGetChildrenAsync Method

Task GetChildrenAsync(
	string pattern,
	IOperationContext operationContext,
	IFolderListingResultContext resultContext,
	CancellationToken cancellationToken
)

Function GetChildrenAsync ( 
	pattern As String,
	operationContext As IOperationContext,
	resultContext As IFolderListingResultContext,
	cancellationToken As CancellationToken
) As Task

Task^ GetChildrenAsync(
	String^ pattern, 
	IOperationContext^ operationContext, 
	IFolderListingResultContext^ resultContext, 
	CancellationToken cancellationToken
)

abstract GetChildrenAsync : 
        pattern : string * 
        operationContext : IOperationContext * 
        resultContext : IFolderListingResultContext * 
        cancellationToken : CancellationToken -> Task 

Parameters

pattern

Type: SystemString
Search pattern. In case of Windows, this is a standard Windows file pattern which may contain wildcard characters(‘?’, ‘*’). All placeholders information matching the pattern must be transferred, but not necessarily in one-shot, as a minimum requirement. Alternatively, your file system implementation may choose to not transfer placeholders matching the pattern.

operationContext

Type: ITHit.FileSystemIOperationContext
Provides information about the environment.

resultContext

Type: ITHit.FileSystemIFolderListingResultContext
Used to return list of files and folders from this call to the platform. Also provides methods for reporting progress and operation status.

cancellationToken

Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.

Return Value

To return list of files and folders you will call the ReturnChildrenAsync(IFileSystemItemMetadata, Int64, Boolean, CancellationToken) method passed via resultContext parameter. Inside this method implementation you can call ReturnChildrenAsync(IFileSystemItemMetadata, Int64, Boolean, CancellationToken) method multiple times, returning the list of files and folders in several turns.

On Windows this method has a 60 sec timeout. To process longer requests call the ReturnChildrenAsync(IFileSystemItemMetadata, Int64, Boolean, CancellationToken) method or report progress using the ReportProgress(Int64, Int64) method.

Reference