IFolderListingResultContextReturnChildrenAsync Method

Task ReturnChildrenAsync(
	IFileSystemItemMetadata[] aChildrenBlock,
	long childrenTotalCount,
	bool disableOnDemandPopulation = true,
	CancellationToken cancellationToken = null
)

Function ReturnChildrenAsync ( 
	aChildrenBlock As IFileSystemItemMetadata(),
	childrenTotalCount As Long,
	Optional disableOnDemandPopulation As Boolean = true,
	Optional cancellationToken As CancellationToken = Nothing
) As Task

Task^ ReturnChildrenAsync(
	array<IFileSystemItemMetadata^>^ aChildrenBlock, 
	long long childrenTotalCount, 
	bool disableOnDemandPopulation = true, 
	CancellationToken cancellationToken = nullptr
)

abstract ReturnChildrenAsync : 
        aChildrenBlock : IFileSystemItemMetadata[] * 
        childrenTotalCount : int64 * 
        ?disableOnDemandPopulation : bool * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _disableOnDemandPopulation = defaultArg disableOnDemandPopulation true
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task 

Parameters

aChildrenBlock

Type: ITHit.FileSystemIFileSystemItemMetadata
Array of files and folders.

childrenTotalCount

Type: SystemInt64
Total number of items that should be returned in response to GetChildrenAsync(String, IOperationContext, IFolderListingResultContext, CancellationToken) call.

disableOnDemandPopulation (Optional)

Type: SystemBoolean
Set this parameter to true to indicate that all children has loaded. This will prevent any further folder listings and calls to GetChildrenAsync(String, IOperationContext, IFolderListingResultContext, CancellationToken). Set this parameter to false if you enabled the streaming mode by setting the [!:StorageProviderHydrationPolicyModifier.StreamingAllowed] flag in [!:StorageProviderSyncRootInfo.HydrationPolicyModifier] when registering the virtual file system.

cancellationToken (Optional)

Type: System.ThreadingCancellationToken

Return Value

You can call this method multiple times during a single GetChildrenAsync(String, IOperationContext, IFolderListingResultContext, CancellationToken) call, until all files and folders are passed. The total number of files and folders is passed via childrenTotalCount parameter.

This call will reset the 60 sec timeout timer.

Reference