classwork.pp

Introduction

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Classes hierarchy graph

Class ABookmarkedInputStream

DescriptionHierarchyFieldsMethodsProperties

Unit

classwork

Declaration

type ABookmarkedInputStream = class(ABookmarkedStream)

Description

This class represents a stream that is capable of reading a dictionary of bookmarks from itself.

Instances of ABookmarkedInputStream are not able to write their dictionary of bookmarks, but they can read it. The idea is that, as soon as the stream is created or opened, the dictionary of bookmarks is read so that it can then be used to find specific data.

Hierarchy

Overview

Methods

Public function read(const count: TStreamIOSize; var dest): TStreamIOSize; override;
Public function readBookmarksAt(const thisPosition: TStreamOffset): TStreamIOSize; virtual;
Public function readBookmarks: TStreamIOSize; virtual;

Description

Methods

Public function read(const count: TStreamIOSize; var dest): TStreamIOSize; override;

Read count bytes from the stream and place them into dest.

This method overrides the behavior inherited from AStreamWrapper (which does nothing); it passes the call to ABookmarkedInputStream.Target and returns the result.

Returns

The total number of bytes read from the stream.

Public function readBookmarksAt(const thisPosition: TStreamOffset): TStreamIOSize; virtual;

Read the dictionary of bookmarks from the specified position within the stream.

This method moves the stream position pointer to the position specified, then calls AStreamBookmarkDictionary.readFrom. When all bookmarks have been read, the stream position pointer is returned to its previous location.

If Self.Bookmarks is Nil, this method will construct an instance of AStreamBookmarkDictionary to manage the bookmarks read. This behavior allows descendant classes to construct an instance of a different type of bookmarks dictionary, before this method is called (as part of their initialization routines, for instance), which can handle custom bookmark types.

Returns

The total number of bytes read from the stream.

Public function readBookmarks: TStreamIOSize; virtual;

Read the dictionary of bookmarks from the current position within the stream.

This method simply calls Self.readBookmarksAt, passing the value of Self.position.

Returns

The total number of bytes read from the stream.

Generated by PasDoc 0.13.0 on 2015-06-23 19:40:11