Interface IVirtualFileOverlay

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type IVirtualFileOverlay = interface(IInterface)

Description

Object encapsulating information about overlaying virtual file/directories over the real file system.

Attributes
GUID['{9FE70505-90FC-475F-A436-386D68399A5D}']

Hierarchy

  • IInterface
  • IVirtualFileOverlay

Overview

Methods

Public function GetHandle: TCXVirtualFileOverlay;
Public function AddFileMapping(const AVirtualPath, ARealPath: String): TError;
Public function SetCaseSensitivity(const ACaseSensitive: Boolean): TError;
Public function WriteToBuffer(out ABuffer: TBytes): TError;

Properties

Public property Handle: TCXVirtualFileOverlay read GetHandle;

Description

Methods

Public function GetHandle: TCXVirtualFileOverlay;
 
Public function AddFileMapping(const AVirtualPath, ARealPath: String): TError;

Map an absolute virtual file path to an absolute real one. The virtual path must be canonicalized (not contain "."/"..").

Public function SetCaseSensitivity(const ACaseSensitive: Boolean): TError;

Set the case sensitivity. The virtual file overlay object is case-sensitive by default, but this option can be used to override the default.

Public function WriteToBuffer(out ABuffer: TBytes): TError;

Write out the virtual file overlay object to a byte buffer.

Properties

Public property Handle: TCXVirtualFileOverlay read GetHandle;

Internal handle to C API


Generated by PasDocEx, based on PasDoc 0.14.0.