Skip to content

05c85d1b e4e2 db6e 96e7 2b1e8b63402d

AnyOldName3 edited this page Apr 12, 2017 · 1 revision

Source Class

Represents a source (individual layer) in the LVFS.

Inheritance Hierarchy

System.Object
  LVFS.External.Source
    LVFS.External.WritableSource
Namespace: LVFS.External
Assembly: LVFS (in LVFS.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#

public abstract class Source

VB

Public MustInherit Class Source

C++

public ref class Source abstract

F#

[<AbstractClassAttribute>]
type Source =  class end

The Source type exposes the following members.

Constructors

 

Name Description
Protected method Source Construct a source.
  Back to Top

Properties

 

Name Description
Public property HasWritablePredecessor True if a predecessor source exists and is writable
Public property IsFirst True if this source has no predecessor. False otherwise.
Public property IsWritable True if the source is writable
  Back to Top

Methods

 

Name Description
Public method CleanupFileHandle Called when the last handle for a file has been closed, but not necessarily released. This is an appropriate place to delete the file if DeleteOnClose is set. This must recursively call the predecessor version if the predecessor source may have been invloved in any operations with this context.
Public method CloseFileHandle Called once the last handle for a file has been closed and released. info.Context will be lost after this method returns, so must be ready for this. This must recursively call the predecessor version if the predecessor source may have been invloved in any operations with this context.
Public method ControlsFile Gets whether or not this source controls the specified file
Public method CreateFileHandle Called when a file handle is requested. If this is an inappropriate action for this source, the request is passed on to the predecessor.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetFileInformation Gets file information for the file with the specified path (if it exists in this source or a predecessor), or null otherwise.
Public method GetFileSystemSecurity Gets a FileSystemSecurity object representing security information for the requested path, filtered to only include the specified sections. Returns null if the file cannot be found in this or a predecessor source, and throws an UnauthorisedAccessException if the OS denies access to the data requested.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Protected method GetPredecessorFileInformation As with GetFileInformation, but for the predecessor source.
Protected method GetPredecessorFileSystemSecurity As with GetFileSystemSecurity, but for the predecessor source.
Public method GetSpaceInformation If possible, returns a tuple of the free, total and available space for the storage medium holding the current source. Otherwise, returns null.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HasDirectory Gets whether or not this source or a predecessor controls the specified directory.
Public method HasFile Gets whether or not this source or a predecessor controls the specified file.
Public method HasFilesInDirectory Gets whether or not this source or a predecessor exposes a directory which is non-empty.
Public method HasRegularFile Gets whether or not this source or a predecessor controls the specified regular (i.e. non-directory) file.
Public method ListFiles Lists the files and subdirectories contained within a given directory, including those of the predecessor source.
Protected method ListPredecessorFiles As with ListFiles, but for the predecessor source.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method OnMount Called when a filesystem including the source is mounted.
Public method OnUnmount Called when a filesystem including the source is unmounted.
Protected method PredecessorCleanupFileHandle As with CleanupFileHandle, but for the predecessor source.
Protected method PredecessorCloseFileHandle As with CloseFileHandle, but for the predecessor source.
Protected method PredecessorCreateFileHandle As with CreateFileHandle, but for the predecessor source.
Protected method PredecessorHasDirectory As with HasDirectory(String), but for the predecessor source.
Protected method PredecessorHasFile As with HasFile(String), but for the predecessor source
Protected method PredecessorHasFilesInDirectory As with HasFilesInDirectory(String), but for the predecessor source.
Protected method PredecessorHasRegularFile As with HasRegularFile(String), but for the predecessor source.
Protected method PredecessorReadFile As with ReadFile, but for the predecessor source.
Protected method PredecessorTryLockFileRegion As with TryLockFileRegion, but for the predecessor source.
Protected method PredecessorTryUnlockFileRegion As with TryUnlockFileRegion, but for the predecessor source.
Public method ReadFile Gets the contents of the specified file starting at the specified offset and attempts to fill the buffer. If this is an inappropriate action for this source, the request is passed on to the predecessor.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryLockFileRegion Locks a region of the specified file from the specified offset with the specified length if possible. The region is either entirely locked or entirely unlocked at the end of the operation. If this is an inappropriate action for this source, the request is passed on to the predecessor.
Public method TryUnlockFileRegion Unlocks a region of the specified file from the specified offset with the specified length if possible. If this is an inappropriate action for this source, the request is passed on to the predecessor.
  Back to Top

See Also

Reference

LVFS.External Namespace

Clone this wiki locally