|
Fairport
v1.0.38
|
A PST file. More...
#include <pst.h>
Inheritance diagram for fairport::pst:
Collaboration diagram for fairport::pst: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. | |
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:
| typedef boost::transform_iterator<folder_transform_info, folder_filter_iterator> fairport::pst::folder_iterator |
| typedef boost::transform_iterator<message_transform_info, message_filter_iterator> fairport::pst::message_iterator |
| fairport::pst::pst | ( | const std::wstring & | filename | ) | [inline] |
| fairport::pst::pst | ( | pst && | other | ) | [inline] |
| folder_iterator fairport::pst::folder_begin | ( | ) | const [inline] |
| folder_iterator fairport::pst::folder_end | ( | ) | const [inline] |
| shared_db_ptr fairport::pst::get_db | ( | ) | const [inline] |
| std::wstring fairport::pst::get_name | ( | ) | const [inline] |
| fairport::name_id_map & fairport::pst::get_name_id_map | ( | ) | [inline] |
| const fairport::name_id_map & fairport::pst::get_name_id_map | ( | ) | const [inline] |
| fairport::property_bag & fairport::pst::get_property_bag | ( | ) | [inline] |
| const fairport::property_bag & fairport::pst::get_property_bag | ( | ) | const [inline] |
| named_prop fairport::pst::lookup_name_prop | ( | prop_id | id | ) | const [inline] |
| prop_id fairport::pst::lookup_prop_id | ( | const named_prop & | n | ) | [inline] |
| message_iterator fairport::pst::message_begin | ( | ) | const [inline] |
| message_iterator fairport::pst::message_end | ( | ) | const [inline] |
| fairport::folder fairport::pst::open_folder | ( | const std::wstring & | name | ) | const [inline] |
| folder fairport::pst::open_root_folder | ( | ) | const [inline] |
| search_folder fairport::pst::open_search_folder | ( | node_id | id | ) | const [inline] |
Open a specific message in this file.
| [in] | id | The node_id of the message to open |
| key_not_found<node_id> | If a search_folder of the specified id was not found in this file |