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: 3.3.9602.0

Syntax

C++

Copy

public class PlaceholderFile : PlaceholderItem

Public Class PlaceholderFile
	Inherits PlaceholderItem

public ref class PlaceholderFile : public PlaceholderItem

type PlaceholderFile =  
    class
        inherit PlaceholderItem
    end

The PlaceholderFile type exposes the following members.

Constructors

	Name	Description
	PlaceholderFile	Creates an instance of this class.

Top

Methods

	Name	Description
	ConvertToPlaceholderFile	Converts a normal file to a placeholder file. Optionally dehydrates the file.
	Dehydrate(Int64, Int64)	Removes file content from user file system.
	Dehydrate(SafeFileHandle, Int64, Int64)	Removes file content from user file system by handle.
	DehydrationRequired	Returns true if dehydration is required. False - otherwise.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetCustomData	Gets custom data associated with the placeholder. (Inherited from PlaceholderItem.)
	GetFileDataSizeInfo	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.
	GetFileDataSizeInfo(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.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInSync	Gets in-sync state of the placeholder. (Inherited from PlaceholderItem.)
	GetItemId	Gets item ID associated with the placeholder. (Inherited from PlaceholderItem.)
	GetState	Gets placeholder state. (Inherited from PlaceholderItem.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Hydrate	Loads file content to user file system from remote storage.
	HydrationRequired	Returns true if hydration is required. False - otherwise.
	IsPinned	Returns true if item is pinned. False - otherwise. (Inherited from PlaceholderItem.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RevertPlaceholder	Reverts a placeholder back to a regular file or folder. (Inherited from PlaceholderItem.)
	SetCustomData	Sets custom data associated with the placeholder. (Inherited from PlaceholderItem.)
	SetInSync(Boolean)	Marks the placeholder file as in sync or not in sync. (Inherited from PlaceholderItem.)
	SetItemId	Sets item ID associated with the placeholder. (Inherited from PlaceholderItem.)
	SetMetadata	Updates placeholder file information and file content if the file is hydrated. (Overrides PlaceholderItemSetMetadata(IFileSystemItemMetadata).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	Path	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.

Reference

ITHit.FileSystem.Windows Namespace