LDAPAttributeList Class Reference

This container class is used to store multiple LDAPAttribute-objects. More...

#include <LDAPAttributeList.h>

List of all members.

Public Types
typedef ListType::const_iterator	const_iterator
typedef ListType::iterator	iterator
Public Member Functions
	LDAPAttributeList (const LDAPAttributeList &al)
	Copy-constructor.
	LDAPAttributeList (const LDAPAsynConnection *ld, LDAPMessage *msg)
	For internal use only.
	LDAPAttributeList ()
	Constructs an empty list.
virtual	~LDAPAttributeList ()
	Destructor.
size_t	size () const
bool	empty () const
const_iterator	begin () const
const_iterator	end () const
const LDAPAttribute *	getAttributeByName (const std::string &name) const
	Get an Attribute by its AttributeType.
void	addAttribute (const LDAPAttribute &attr)
	Adds one element to the end of the list.
LDAPMod **	toLDAPModArray () const
	Translates the list of Attributes to a 0-terminated array of LDAPMod-structures as needed by the C-API.
Private Types
typedef std::list< LDAPAttribute >	ListType
Private Attributes
ListType	m_attrs
Friends
std::ostream &	operator<< (std::ostream &s, const LDAPAttributeList &al)
	This method can be used to dump the data of a LDAPResult-Object.

---

Detailed Description

This container class is used to store multiple LDAPAttribute-objects.

---

Member Typedef Documentation

typedef ListType::const_iterator LDAPAttributeList::const_iterator

typedef ListType::iterator LDAPAttributeList::iterator

typedef std::list<LDAPAttribute> LDAPAttributeList::ListType [private]

---

Constructor & Destructor Documentation

LDAPAttributeList::LDAPAttributeList (  const LDAPAttributeList &  al  )

Copy-constructor.

LDAPAttributeList::LDAPAttributeList (  const LDAPAsynConnection *  ld, LDAPMessage *  msg )

For internal use only. This constructor is used by the library internally to create a list of attributes from a LDAPMessage-struct that was return by the C-API

LDAPAttributeList::LDAPAttributeList (   )

Constructs an empty list.

LDAPAttributeList::~LDAPAttributeList (   )  [virtual]

Destructor.

---

Member Function Documentation

void LDAPAttributeList::addAttribute (  const LDAPAttribute &  attr  )

Adds one element to the end of the list. Parameters: attr  The attribute to add to the list.

LDAPAttributeList::const_iterator LDAPAttributeList::begin (   )  const

Returns: A iterator that points to the first element of the list.

bool LDAPAttributeList::empty (   )  const

Returns: true if there are zero LDAPAttribute-objects currently stored in this list.

LDAPAttributeList::const_iterator LDAPAttributeList::end (   )  const

Returns: A iterator that points to the element after the last element of the list.

const LDAPAttribute* LDAPAttributeList::getAttributeByName (  const std::string &  name  )  const

Get an Attribute by its AttributeType. Parameters: name  The name of the Attribute to look for Returns: a pointer to the LDAPAttribute with the AttributeType "name" or 0, if there is no Attribute of that Type

size_t LDAPAttributeList::size (   )  const

Returns: The number of LDAPAttribute-objects that are currently stored in this list.

LDAPMod ** LDAPAttributeList::toLDAPModArray (   )  const

Translates the list of Attributes to a 0-terminated array of LDAPMod-structures as needed by the C-API.

---

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  s, const LDAPAttributeList &  al )  [friend]

This method can be used to dump the data of a LDAPResult-Object. It is only useful for debugging purposes at the moment

---

Member Data Documentation

ListType LDAPAttributeList::m_attrs [private]

---

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

• LDAPAttributeList.h
• LDAPAttributeList.cpp

---