NAME

Finnigan::OLE2DirectoryEntry -- a decoder for the Microsoft OLE2 directory entry

SYNOPSIS

use Finnigan;
my $dir = new Finnigan::OLE2DirectoryEntry($ole2file, 0);
$dir->list();

DESCRIPTION

The OLE2 directory entries are organized in a red-black tree (for efficiency of access). The directory entry's constructor method new() is called recursively starting from the root directory contained in the file's 0-th property.

METHODS

new($file, $propertyIndex)

The constructor method. Its first argument is a reference to Finnigan::OLE2File, and the second argument is the index of the file's property (Finnigan::OLE2Property) to be decoded as a directory entry. The root directory is always found in property number 0.

list($style)

Lists the directory's contents to STDOUT. The style argument can have three values: wiki, html, and plain (or undefined). The wiki and html styles have not been implemented yet.

This method is not useful as part of the API (directory listings are better understood by humans). But once the path to a node is known, it can be retrieved with the find method.

find($path)

Get the directory entry (Finnigan::OLE2DirectoryEntry) matching the path supplied in the only argument. The directory entry's data method needs to be called in order to extract the node data.=back

PRIVATE METHODS

data

file

name

render_list_item

size

start

type

SEE ALSO

Finnigan::OLE2File

Finnigan::OLE2Property

AUTHOR

Gene Selkov, <selkovjr@gmail.com>

COPYRIGHT AND LICENSE

Copyright (C) 2010 by Gene Selkov

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.