Search Folder object. More...

#include <folder.h>

Collaboration diagram for pstsdk::search_folder:

Public Types
typedef boost::transform_iterator< message_transform_row, const_table_row_iter >	message_iterator
	Message iterator type; a transform iterator over a table row iterator.

Public Member Functions
	search_folder (const shared_db_ptr &db, const node &n)
	Construct a search folder object.

	search_folder (const search_folder &other)
	Copy construct a search folder object.

	search_folder (search_folder &&other)
	Move construct a search folder.

message_iterator	message_begin () const
	Get an iterator to the first message in this folder.

message_iterator	message_end () const
	Get the end message iterator.

std::wstring	get_name () const
	Get the display name of this folder.

size_t	get_unread_message_count () const
	Get the number of unread messages in this folder.

size_t	get_message_count () const
	Get the number of messages in this folder.

property_bag &	get_property_bag ()
	Get the property bag backing this folder.

const property_bag &	get_property_bag () const
	Get the property bag backing this folder.

shared_db_ptr	get_db () const
	Get the database pointer used by this folder.

table &	get_contents_table ()
	Get the contents table of this folder.

const table &	get_contents_table () const
	Get the contents table of this folder.

node_id	get_id () const
	Get the node_id of this search folder.

Detailed Description

Search Folder object.

Search folders are different from regular folders mainly in that they do not have a hierarchy table (and thus no subfolders). The messages they "contain" are actually in other folders.

This object exists to reflect that limited interface. Eventually this object may support querying the criteria used to create the search folder.

Definition at line 62 of file folder.h.

Member Typedef Documentation

◆ message_iterator

typedef boost::transform_iterator<message_transform_row, const_table_row_iter> pstsdk::search_folder::message_iterator

Message iterator type; a transform iterator over a table row iterator.

Definition at line 66 of file folder.h.

Constructor & Destructor Documentation

◆ search_folder() [1/3]

pstsdk::search_folder::search_folder	(	const shared_db_ptr &	db,
		const node &	n
	)

inline

Construct a search folder object.

Parameters

[in]	db	The database pointer
[in]	n	A search folder node

Definition at line 71 of file folder.h.

◆ search_folder() [2/3]

pstsdk::search_folder::search_folder ( const search_folder & other )

inline

Copy construct a search folder object.

Definition at line 340 of file folder.h.

◆ search_folder() [3/3]

pstsdk::search_folder::search_folder ( search_folder && other )

inline

Move construct a search folder.

Definition at line 78 of file folder.h.

Member Function Documentation

◆ get_contents_table() [1/2]

pstsdk::table & pstsdk::search_folder::get_contents_table ( )

inline

Get the contents table of this folder.

Returns: The contents table

Definition at line 371 of file folder.h.

◆ get_contents_table() [2/2]

const pstsdk::table & pstsdk::search_folder::get_contents_table ( ) const

inline

Get the contents table of this folder.

Returns: The contents table

Definition at line 363 of file folder.h.

◆ get_db()

shared_db_ptr pstsdk::search_folder::get_db ( ) const

inline

Get the database pointer used by this folder.

Returns: The database pointer

Definition at line 116 of file folder.h.

◆ get_id()

node_id pstsdk::search_folder::get_id ( ) const

inline

Get the node_id of this search folder.

Returns: The node_id of the search folder

Definition at line 126 of file folder.h.

◆ get_message_count()

size_t pstsdk::search_folder::get_message_count ( ) const

inline

Get the number of messages in this folder.

Returns: The number of messages

Definition at line 103 of file folder.h.

◆ get_name()

std::wstring pstsdk::search_folder::get_name ( ) const

inline

Get the display name of this folder.

Returns: The name of this folder

Definition at line 95 of file folder.h.

◆ get_property_bag() [1/2]

property_bag & pstsdk::search_folder::get_property_bag ( )

inline

Get the property bag backing this folder.

Returns: The property bag

Definition at line 109 of file folder.h.

◆ get_property_bag() [2/2]

const property_bag & pstsdk::search_folder::get_property_bag ( ) const

inline

Get the property bag backing this folder.

Returns: The property bag

Definition at line 112 of file folder.h.

◆ get_unread_message_count()

size_t pstsdk::search_folder::get_unread_message_count ( ) const

inline

Get the number of unread messages in this folder.

Returns: The number of unread messages

Definition at line 99 of file folder.h.

◆ message_begin()

message_iterator pstsdk::search_folder::message_begin ( ) const

inline

Get an iterator to the first message in this folder.

Returns: an iterator positioned on the first message in this folder

Definition at line 85 of file folder.h.

◆ message_end()

message_iterator pstsdk::search_folder::message_end ( ) const

inline

Get the end message iterator.

Returns: an iterator at the end position

Definition at line 89 of file folder.h.

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

pstsdk/pst/folder.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ message_iterator

Constructor & Destructor Documentation

◆ search_folder() [1/3]

◆ search_folder() [2/3]

◆ search_folder() [3/3]

Member Function Documentation

◆ get_contents_table() [1/2]

◆ get_contents_table() [2/2]

◆ get_db()

◆ get_id()

◆ get_message_count()

◆ get_name()

◆ get_property_bag() [1/2]

◆ get_property_bag() [2/2]

◆ get_unread_message_count()

◆ message_begin()

◆ message_end()