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.1.26791.0-Beta2

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.

Properties

	Name	Description
	Properties	Custom data associated with a placeholder, organised as a dictionary. (Overrides PlaceholderItemProperties.)

Top

Methods

	Name	Description
	Dehydrate(SafeFileHandle, Int64, Int64)	Removes file content from user file system by handle.
	Dehydrate(Int64, Int64, FileShare)	Removes file content from the user file system.
	Dehydrate(String, Int64, Int64, FileShare)	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.)
	GetErrorStatus	Gets error status. (Inherited from PlaceholderItem.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInSync	Gets in-sync state of the placeholder. (Inherited from PlaceholderItem.)
	GetRemoteStorageItemId	Gets remote storage item ID associated with the placeholder or null if the ID was not set. (Inherited from PlaceholderItem.)
	GetState	Gets placeholder state. (Inherited from PlaceholderItem.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Hydrate(SafeFileHandle, Int64, Int64)	Loads file content to user file system from remote storage.
	Hydrate(Int64, Int64, FileShare)	Loads file content to user file system from remote storage.
	Hydrate(String, Int64, Int64, FileShare)	Loads file content to user file system from remote storage.
	HydrationRequired	Returns true if hydration is required. False - otherwise.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetConflictStatus	Sets or clears error status icon to indicate synchronization status. (Inherited from PlaceholderItem.)
	SetInSync	Marks the placeholder file as in sync or not in sync. (Inherited from PlaceholderItem.)
	SetRemoteStorageItemId	Sets remote storage item ID associated with the placeholder. (Inherited from PlaceholderItem.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryDehydrate(SafeFileHandle, Int64, Int64)	Tries to remove file content from user file system.
	TryDehydrate(Int64, Int64, FileShare)	Tries to remove file content from user file system.
	TryDehydrate(String, Int64, Int64, FileShare)	Tries to remove file content from user file system.
	TryDehydrationRequired	Tries to determin if the dehydration is required.
	TryGetErrorStatus(Boolean)	Tries to get error status. (Inherited from PlaceholderItem.)
	TryGetRemoteStorageItemId	Tries to get remote storage item ID associated with the placeholder. (Inherited from PlaceholderItem.)
	TryGetState	Tries to get placeholder state. (Inherited from PlaceholderItem.)
	TryHydrate(SafeFileHandle, Int64, Int64)	Tries to load file content to user file system from remote storage.
	TryHydrate(Int64, Int64, FileShare)	Tries to load file content to user file system from remote storage.
	TryHydrate(String, Int64, Int64, FileShare)	Tries to load file content to user file system from remote storage.
	TryHydrationRequired	Tries to determin if the hydration is required.
	TrySetErrorStatus(Boolean)	Tries to set or clear error status icon to indicate synchronization status. (Inherited from PlaceholderItem.)
	TryShadowDownloadAsync
	UpdateUI	Force a refresh of PlaceholderItem in shell user interface. (Inherited from PlaceholderItem.)

Top

Fields

	Name	Description
	Engine	Engine. (Inherited from PlaceholderItem.)
	Path	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.

Reference

ITHit.FileSystem.Windows Namespace