pstsdk::named_prop Class Reference

A named property. More...

#include <nameid.h>

Collaboration diagram for pstsdk::named_prop:

Public Member Functions
	named_prop (const guid &g, long id)
	Construct a named prop from a guid and an id.
	named_prop (const guid &g, const std::wstring &name)
	Construct a named prop from a guid and a string.
const guid &	get_guid () const
	Get the namespace GUID of which this named prop is a member.
bool	is_string () const
	Return true if this is a string named prop.
long	get_id () const
	Get the numerical id of this property.
const std::wstring &	get_name () const
	Get the name of this property.

Detailed Description

A named property.

The equivalent of a MAPI named property. This is one half of the named property/prop id mapping. This is used as both a key and value type, depending on which way in the named property mapping you're going.

Definition at line 30 of file nameid.h.

Constructor & Destructor Documentation

named_prop() [1/2]

pstsdk::named_prop::named_prop ( const guid &  g, long  id  )

inline

Construct a named prop from a guid and an id.

Parameters

[in]	g	The GUID which this named prop is a member
[in]	id	The numerical id for this property

Definition at line 36 of file nameid.h.

named_prop() [2/2]

pstsdk::named_prop::named_prop ( const guid &  g, const std::wstring &  name  )

inline

Construct a named prop from a guid and a string.

Parameters

[in]	g	The GUID which this named prop is a member
[in]	name	The string name for this property

Definition at line 41 of file nameid.h.

Member Function Documentation

get_guid()

const guid & pstsdk::named_prop::get_guid ( ) const

inline

Get the namespace GUID of which this named prop is a member.

Returns

The GUID for the namespace this named property is in

Definition at line 46 of file nameid.h.

get_id()

long pstsdk::named_prop::get_id ( ) const

inline

Get the numerical id of this property.

Precondition

is_string() == false

Returns

The numerical id of this named prop

Definition at line 53 of file nameid.h.

get_name()

const std::wstring & pstsdk::named_prop::get_name ( ) const

inline

Get the name of this property.

Precondition

is_string() == true

Returns

The name of this property

Definition at line 57 of file nameid.h.

is_string()

bool pstsdk::named_prop::is_string ( ) const

inline

Return true if this is a string named prop.

Returns

true if this is a string named prop

Definition at line 49 of file nameid.h.

---

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

• pstsdk/ltp/nameid.h