Click or drag to resize

PlaceholderFile Class

IT Hit User File System
Represents a file placeholder in Windows file system.
Inheritance Hierarchy
SystemObject
  ITHit.FileSystem.WindowsPlaceholderItem
    ITHit.FileSystem.WindowsPlaceholderFile

Namespace:  ITHit.FileSystem.Windows
Assembly:  ITHit.FileSystem.Windows (in ITHit.FileSystem.Windows.dll) Version: 8.0.26019.0-Beta+92e3f56e17dbfd6ebbef85925c0684282db3d967
Syntax
public class PlaceholderFile : PlaceholderItem

The PlaceholderFile type exposes the following members.

Properties
  NameDescription
Public propertyProperties
Custom data associated with a placeholder, organised as a dictionary.
(Overrides PlaceholderItemProperties.)
Top
Methods
  NameDescription
Public methodStatic memberDehydrate(SafeFileHandle, Int64, Int64)
Removes file content from user file system by handle.
Public methodDehydrate(Int64, Int64, FileShare)
Removes file content from the user file system.
Public methodStatic memberDehydrate(String, Int64, Int64, FileShare)
Removes file content from user file system by handle.
Public methodDehydrationRequired
Returns true if dehydration is required. False - otherwise.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetErrorStatus
Gets error status.
(Inherited from PlaceholderItem.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInSync
Gets in-sync state of the placeholder.
(Inherited from PlaceholderItem.)
Public methodGetRemoteStorageItemId
Gets remote storage item ID associated with the placeholder or null if the ID was not set.
(Inherited from PlaceholderItem.)
Public methodGetState
Gets placeholder state.
(Inherited from PlaceholderItem.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberHydrate(SafeFileHandle, Int64, Int64)
Loads file content to user file system from remote storage.
Public methodHydrate(Int64, Int64, FileShare)
Loads file content to user file system from remote storage.
Public methodStatic memberHydrate(String, Int64, Int64, FileShare)
Loads file content to user file system from remote storage.
Public methodHydrationRequired
Returns true if hydration is required. False - otherwise.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetConflictStatus
Sets or clears error status icon to indicate synchronization status.
(Inherited from PlaceholderItem.)
Public methodSetInSync
Marks the placeholder file as in sync or not in sync.
(Inherited from PlaceholderItem.)
Public methodSetRemoteStorageItemId
Sets remote storage item ID associated with the placeholder.
(Inherited from PlaceholderItem.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodStatic memberTryDehydrate(SafeFileHandle, Int64, Int64)
Tries to remove file content from user file system.
Public methodTryDehydrate(Int64, Int64, FileShare)
Tries to remove file content from user file system.
Public methodStatic memberTryDehydrate(String, Int64, Int64, FileShare)
Tries to remove file content from user file system.
Public methodTryDehydrationRequired
Tries to determin if the dehydration is required.
Public methodTryGetErrorStatus(Boolean)
Tries to get error status.
(Inherited from PlaceholderItem.)
Public methodTryGetRemoteStorageItemId
Tries to get remote storage item ID associated with the placeholder.
(Inherited from PlaceholderItem.)
Public methodTryGetState
Tries to get placeholder state.
(Inherited from PlaceholderItem.)
Public methodStatic memberTryHydrate(SafeFileHandle, Int64, Int64)
Tries to load file content to user file system from remote storage.
Public methodTryHydrate(Int64, Int64, FileShare)
Tries to load file content to user file system from remote storage.
Public methodStatic memberTryHydrate(String, Int64, Int64, FileShare)
Tries to load file content to user file system from remote storage.
Public methodTryHydrationRequired
Tries to determin if the hydration is required.
Public methodTrySetErrorStatus(Boolean)
Tries to set or clear error status icon to indicate synchronization status.
(Inherited from PlaceholderItem.)
Public methodTryShadowDownloadAsync
Public methodUpdateUI
Force a refresh of PlaceholderItem in shell user interface.
(Inherited from PlaceholderItem.)
Top
Fields
  NameDescription
Public fieldEngine
Engine.
(Inherited from PlaceholderItem.)
Public fieldPath
Path of this placeholder in the user file system.
(Inherited from PlaceholderItem.)
Top
Remarks
Unlike a regular file, the placeholder can occupy only a small ammount of space in file system. It loads data from a remore storage when access to the file is detected.
See Also