libmapipp::property_container Class Reference

A container of properties to be used with classes derived from object. More...

#include <property_container.h>

Public Types

typedef property_container_iterator iterator
 
typedef const void * value_type
 

Public Member Functions

iterator begin () const
 
iterator end () const
 
uint32_t fetch ()
 Fetches properties with the tags supplied using operator<<. More...
 
void fetch_all ()
 Fetches ALL properties of the object associated with this container. More...
 
enum MAPITAGS get_tag_at (uint32_t pos)
 
property_containeroperator<< (uint32_t property_tag)
 Adds a Property Tag to be fetched by fetch(). More...
 
const void * operator[] (uint32_t property_tag)
 Finds the property value associated with a property tag. More...
 
 property_container (TALLOC_CTX *memory_ctx, mapi_object_t &mapi_object)
 Constructor. More...
 
size_t size () const
 Get number of properties in container. More...
 
 ~property_container ()
 Destructor. More...
 

Detailed Description

A container of properties to be used with classes derived from object.

Examples:
attach_test.cpp, foldertree.cpp, messages.cpp, and test.cpp.

Member Typedef Documentation

Constructor & Destructor Documentation

libmapipp::property_container::property_container ( TALLOC_CTX *  memory_ctx,
mapi_object_t &  mapi_object 
)
inline

Constructor.

libmapipp::property_container::~property_container ( )
inline

Destructor.

Member Function Documentation

iterator libmapipp::property_container::begin ( ) const
inline
Examples:
test.cpp.
iterator libmapipp::property_container::end ( ) const
inline
Examples:
test.cpp.
uint32_t libmapipp::property_container::fetch ( )
inline

Fetches properties with the tags supplied using operator<<.

Returns
The number of objects that were fetched.
Examples:
attach_test.cpp, foldertree.cpp, messages.cpp, and test.cpp.
void libmapipp::property_container::fetch_all ( )
inline

Fetches ALL properties of the object associated with this container.

Examples:
test.cpp.
enum MAPITAGS libmapipp::property_container::get_tag_at ( uint32_t  pos)
inline
property_container& libmapipp::property_container::operator<< ( uint32_t  property_tag)
inline

Adds a Property Tag to be fetched by fetch().

const void* libmapipp::property_container::operator[] ( uint32_t  property_tag)
inline

Finds the property value associated with a property tag.

Parameters
property_tagThe Property Tag to be searched for
Returns
Property Value as a const void pointer
size_t libmapipp::property_container::size ( ) const
inline

Get number of properties in container.


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

Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/