Click or drag to resize

PlaceholderFile Class

IT Hit User File System
Represents a file placeholder in Windows file system.
Inheritance Hierarchy

Namespace:  ITHit.FileSystem.Windows
Assembly:  ITHit.FileSystem.Windows (in ITHit.FileSystem.Windows.dll) Version: 3.3.9602.0
Syntax
public class PlaceholderFile : PlaceholderItem

The PlaceholderFile type exposes the following members.

Constructors
  NameDescription
Public methodPlaceholderFile
Creates an instance of this class.
Top
Methods
  NameDescription
Public methodStatic memberConvertToPlaceholderFile
Converts a normal file to a placeholder file. Optionally dehydrates the file.
Public methodDehydrate(Int64, Int64)
Removes file content from user file system.
Public methodStatic memberDehydrate(SafeFileHandle, Int64, Int64)
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 methodGetCustomData
Gets custom data associated with the placeholder.
(Inherited from PlaceholderItem.)
Public methodGetFileDataSizeInfo
Gets information about number of bytes on disk, the number of bytes in-sync with the remote storage and not in-sync with remote storage.
Public methodStatic memberGetFileDataSizeInfo(SafeFileHandle)
Gets information about number of bytes on disk, number of bytes in sync with the remote storage and not on sync with remote storage using file fandle.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInSync
Gets in-sync state of the placeholder.
(Inherited from PlaceholderItem.)
Public methodGetItemId
Gets item ID associated with the placeholder.
(Inherited from PlaceholderItem.)
Public methodGetState
Gets placeholder state.
(Inherited from PlaceholderItem.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHydrate
Loads file content to user file system from remote storage.
Public methodHydrationRequired
Returns true if hydration is required. False - otherwise.
Public methodIsPinned
Returns true if item is pinned. False - otherwise.
(Inherited from PlaceholderItem.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRevertPlaceholder
Reverts a placeholder back to a regular file or folder.
(Inherited from PlaceholderItem.)
Public methodSetCustomData
Sets custom data associated with the placeholder.
(Inherited from PlaceholderItem.)
Public methodSetInSync(Boolean)
Marks the placeholder file as in sync or not in sync.
(Inherited from PlaceholderItem.)
Public methodSetItemId
Sets item ID associated with the placeholder.
(Inherited from PlaceholderItem.)
Public methodCode exampleSetMetadata
Updates placeholder file information and file content if the file is hydrated.
(Overrides PlaceholderItemSetMetadata(IFileSystemItemMetadata).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldPath
Path of this placeholder in 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