fairport::pst Class Reference

A PST file. More...

#include <pst.h>

Inheritance diagram for fairport::pst:

Collaboration diagram for fairport::pst:

List of all members.

Public Types
typedef boost::transform_iterator < message_transform_info, message_filter_iterator >	message_iterator
	Message iterator type; a transform iterator over a filter iterator over a nodeinfo iterator.
typedef boost::transform_iterator < folder_transform_info, folder_filter_iterator >	folder_iterator
	Folder iterator type; a transform iterator over a filter iterator over a nodeinfo iterator.
Public Member Functions
	pst (const std::wstring &filename)
	Construct a pst object from the specified file.
	pst (pst &&other)
	Move constructor.
folder_iterator	folder_begin () const
	Get an iterator to the first folder in the PST file.
folder_iterator	folder_end () const
	Get the end folder iterator.
message_iterator	message_begin () const
	Get an iterator to the first message in the PST file.
message_iterator	message_end () const
	Get the end message iterator.
folder	open_root_folder () const
	Opens the root folder of this file.
folder	open_folder (const std::wstring &name) const
	Open a specific folder in this file.
folder	open_folder (node_id id) const
	Open a specific message in this file.
search_folder	open_search_folder (node_id id) const
	Open a specific message in this file.
message	open_message (node_id id) const
	Open a specific message in this file.
std::wstring	get_name () const
	Get the display name of the PST.
prop_id	lookup_prop_id (const guid &g, const std::wstring &name) const
	Lookup a prop_id of a named prop.
prop_id	lookup_prop_id (const guid &g, long id) const
	Lookup a prop_id of a named prop.
prop_id	lookup_prop_id (const named_prop &n)
	Lookup a prop_id of a named prop.
named_prop	lookup_name_prop (prop_id id) const
	Lookup a named prop of a prop_id.
property_bag &	get_property_bag ()
	Get the property bag of the store object.
name_id_map &	get_name_id_map ()
	Get the named prop map for this store.
const property_bag &	get_property_bag () const
	Get the property bag of the store object.
const name_id_map &	get_name_id_map () const
	Get the named prop map for this store.
shared_db_ptr	get_db () const
	Get the shared database pointer used by this object.

---

Detailed Description

A PST file.

pst represents a pst file on disk. Both OST and PST files are supported, both ANSI and Unicode. Once a client creates a PST file, this object supports:

• iterating over all messages in the store
• iterating over all folders in the store
• opening the root folder
• opening a specific folder by name
• performing named property lookups

Definition at line 48 of file pst.h.

---

Member Typedef Documentation

typedef boost::transform_iterator<folder_transform_info, folder_filter_iterator> fairport::pst::folder_iterator

Folder iterator type; a transform iterator over a filter iterator over a nodeinfo iterator.

Definition at line 57 of file pst.h.

typedef boost::transform_iterator<message_transform_info, message_filter_iterator> fairport::pst::message_iterator

Message iterator type; a transform iterator over a filter iterator over a nodeinfo iterator.

Definition at line 55 of file pst.h.

---

Constructor & Destructor Documentation

fairport::pst::pst

(

const std::wstring &

filename

)

[inline]

Construct a pst object from the specified file.

Parameters:

[in]

filename

The pst file to open on disk

Definition at line 61 of file pst.h.

fairport::pst::pst

(

pst &&

other

)

[inline]

Move constructor.

Parameters:

[in]

other

The other pst file

Definition at line 67 of file pst.h.

---

Member Function Documentation

folder_iterator fairport::pst::folder_begin

(

)

const [inline]

Get an iterator to the first folder in the PST file.

Returns:

an iterator positioned on the first folder in this PST file

Definition at line 74 of file pst.h.

folder_iterator fairport::pst::folder_end

(

)

const [inline]

Get the end folder iterator.

Returns:

an iterator at the end position

Definition at line 78 of file pst.h.

shared_db_ptr fairport::pst::get_db

(

)

const [inline]

Get the shared database pointer used by this object.

Returns:

the shared_db_ptr

Definition at line 165 of file pst.h.

std::wstring fairport::pst::get_name

(

)

const [inline]

Get the display name of the PST.

Returns:

The display name

Definition at line 125 of file pst.h.

fairport::name_id_map & fairport::pst::get_name_id_map

(

)

[inline]

Get the named prop map for this store.

Returns:

The named property map

Definition at line 197 of file pst.h.

const fairport::name_id_map & fairport::pst::get_name_id_map

(

)

const [inline]

Get the named prop map for this store.

Returns:

The named property map

Definition at line 189 of file pst.h.

fairport::property_bag & fairport::pst::get_property_bag

(

)

[inline]

Get the property bag of the store object.

Returns:

The property bag

Definition at line 184 of file pst.h.

const fairport::property_bag & fairport::pst::get_property_bag

(

)

const [inline]

Get the property bag of the store object.

Returns:

The property bag

Definition at line 176 of file pst.h.

named_prop fairport::pst::lookup_name_prop

(

prop_id

id

)

const [inline]

Lookup a named prop of a prop_id.

Parameters:

[in]

id

The prop_id to lookup

Returns:

The mapped named property

Definition at line 147 of file pst.h.

prop_id fairport::pst::lookup_prop_id	(	const guid &	g,
		const std::wstring &	name
	)		const [inline]

Lookup a prop_id of a named prop.

Parameters:

[in]	g	The namespace guid of the named prop to lookup
[in]	name	The name of the property to lookup

Returns:

The prop_id of the property looked up

Definition at line 131 of file pst.h.

prop_id fairport::pst::lookup_prop_id	(	const guid &	g,
		long	id
	)		const [inline]

Lookup a prop_id of a named prop.

Parameters:

[in]	g	The namespace guid of the named prop to lookup
[in]	id	The id of the property to lookup

Returns:

The prop_id of the property looked up

Definition at line 137 of file pst.h.

prop_id fairport::pst::lookup_prop_id

(

const named_prop &

n

)

[inline]

Lookup a prop_id of a named prop.

Parameters:

[in]

n

The named prop to lookup

Returns:

The prop_id of the property looked up

Definition at line 142 of file pst.h.

message_iterator fairport::pst::message_begin

(

)

const [inline]

Get an iterator to the first message in the PST file.

Returns:

an iterator positioned on the first message in this PST file

Definition at line 83 of file pst.h.

message_iterator fairport::pst::message_end

(

)

const [inline]

Get the end message iterator.

Returns:

an iterator at the end position

Definition at line 87 of file pst.h.

fairport::folder fairport::pst::open_folder

(

const std::wstring &

name

)

const [inline]

Open a specific folder in this file.

Parameters:

[in]

name

The name of the folder to open

Exceptions:

key_not_found<std::wstring>

If a folder of the specified name was not found in this file

Returns:

The first folder by that name found in the file

Definition at line 202 of file pst.h.

folder fairport::pst::open_folder

(

node_id

id

)

const [inline]

Open a specific message in this file.

Parameters:

[in]

id

The node_id of the message to open

Exceptions:

key_not_found<node_id>

If a folder of the specified id was not found in this file

Returns:

The folder with that id found in the file

Definition at line 105 of file pst.h.

message fairport::pst::open_message

(

node_id

id

)

const [inline]

Open a specific message in this file.

Parameters:

[in]

id

The node_id of the message to open

Exceptions:

key_not_found<node_id>

If a message of the specified id was not found in this file

Returns:

The message with that id found in the file

Definition at line 119 of file pst.h.

folder fairport::pst::open_root_folder

(

)

const [inline]

Opens the root folder of this file.

Note:

This is specific to PST files, as an OST file has a different root folder

Returns:

The root of the folder hierarchy in this file

Definition at line 93 of file pst.h.

search_folder fairport::pst::open_search_folder

(

node_id

id

)

const [inline]

Open a specific message in this file.

Parameters:

[in]

id

The node_id of the message to open

Exceptions:

key_not_found<node_id>

If a search_folder of the specified id was not found in this file

Returns:

The search_folder with that id found in the file

Definition at line 112 of file pst.h.

---

The documentation for this class was generated from the following file:

• fairport/pst/pst.h