ShellBoost Core Documentation
Namespaces
ShellBoost.Core.Synchronization
OnDemandLocalFileSystem Class
OnDemandLocalFileSystem Methods
AcknowledgeData Method
AddToWaitingForSynchronization Method
CancelHydrateData Method
CheckSupported Method
ConvertMarkInSync Method
ConvertToOnDemandEntry Method
CreateEntry Method
CreateMarkInSync Method
CreateOnDemandEntry Method
DehydrateOnDemandEntry Method
Dispose Method
EnsureRegistered Method
EnsureRegisteredForShell Method
EntryRename Method
ExcludeOnDemandEntry Method
FileOverwrite Method
GetHydrationRequiredCount Method
GetIdentity Method
HandleHydrationError Method
HandleSharingViolation Method
HasCapability Method
HydrateDataAsync Method
HydrateOnDemandEntry Method
InheritPinOnDemandEntry Method
IsAlwaysSynchronized Method
IsHydrating Method
IsOnDemandEntry Method
IsOnDemandEntryExcluded Method
IsOnDemandEntryInSync Method
IsOnDemandEntryNotInSync Method
IsOnDemandEntryPinned Method
IsOnDemandEntryUnpinned Method
IsOnDemandEntryUnspecified Method
Log Method
NotifyDehydrateOnDemandEntry Method
NotifyDehydrateOnDemandEntryCompletion Method
NotifyDeleteOnDemandEntry Method
NotifyDeleteOnDemandEntryCompletion Method
NotifyFileCloseCompletion Method
NotifyFileOpenCompletion Method
NotifyRenameOnDemandEntry Method
NotifyRenameOnDemandEntryCompletion Method
OnJobChanged Method
OnSavedChange Method
OnSavingChange Method
OnWatcherError Method
OnWatcherEvent Method
PinOnDemandEntry Method
RemoveAsOnDemandEntry Method
ReportErrorToShell Method
ReportProgress Method
ReportProgressToShell Method
ReportSyncStatus Method
SetBasicInformation Method
SetInSyncOnDemandEntry Method
SetNotInSyncOnDemandEntry Method
StartFetchDataAction Method
UnpinOnDemandEntry Method
Unregister Method
UnspecifyOnDemandEntry Method
UpdateAllEntriesStates Method
UpdateEntry Method
UpdateEntryStates Method
UpdateFileSystemEntry Method
UpdateMarkInSync Method
UpdateOnDemandEntry Method
UpdateStatus Method
ValidateData Method
Click or drag to resize

OnDemandLocalFileSystemHydrateDataAsync Method

Hydrates the data of an On-Demand file.

Namespace:  ShellBoost.Core.Synchronization
Assembly:  ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
Syntax
C#
Copy
protected virtual Task<int> HydrateDataAsync(
	OnDemandCallbackContext callbackContext,
	string relativePath,
	long offset,
	long count,
	Stream output
)

Parameters

callbackContext
Type: ShellBoost.Core.SynchronizationOnDemandCallbackContext
The callback context. This is an opaque object that can be passed to the ReportProgress method.
relativePath
Type: SystemString
The relative file path.
offset
Type: SystemInt64
The data offset.
count
Type: SystemInt64
The count of bytes to fetch.
output
Type: System.IOStream
The output stream.

Return Value

Type: TaskInt32
0 if operation was successful; otherwise an error code.
Exceptions
ExceptionCondition
ArgumentNullExceptioncallbackContext is null or output is null.
ArgumentException count is invalid or offset is invalid.
See Also