Merge branch 'mdb.master' of ssh://git-master.openldap.org/~git/git/openldap

[openldap] / contrib / ldapc++ / src / LDAPSearchResult.h

diff --git a/contrib/ldapc++/src/LDAPSearchResult.h b/contrib/ldapc++/src/LDAPSearchResult.h
index 7658df0a41ab340dbde32b35e08162e4eb3f43ee..829b88934d44137e208b436cb380f41df5ea5ede 100644 (file)
--- a/contrib/ldapc++/src/LDAPSearchResult.h
+++ b/contrib/ldapc++/src/LDAPSearchResult.h
@@ -1,24 +1,45 @@
+// $OpenLDAP$
 /*
- * Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 2000-2011 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 
-// $Id: LDAPSearchResult.h,v 1.4 2000/08/31 17:43:49 rhafer Exp $
 
 #ifndef LDAP_SEARCH_RESULT_H
 #define LDAP_SEARCH_RESULT_H
 
-#include "LDAPMessage.h"
-#include "LDAPEntry.h"
+#include <LDAPMessage.h>
+#include <LDAPEntry.h>
 
 class LDAPRequest;
 
+/**
+ * This class is used to represent the result entries of a
+ * SEARCH-operation.
+ */
 class LDAPSearchResult : public LDAPMsg{
-       private:
-               LDAPEntry *entry;
-       public:
-               LDAPSearchResult(LDAPRequest *req, LDAPMessage *msg);
-               virtual ~LDAPSearchResult();
-               LDAPEntry* getEntry();
+    public:
+        /**
+         * Constructor that create an object from the C-API structures
+         */
+        LDAPSearchResult(const LDAPRequest *req, LDAPMessage *msg);
+
+        /**
+         * Copy-Constructor
+         */
+        LDAPSearchResult(const LDAPSearchResult& res);
+
+        /**
+         * The Destructor
+         */
+        virtual ~LDAPSearchResult();
+
+        /**
+         * @returns The entry that has been sent with this result message. 
+         */
+        const LDAPEntry* getEntry() const;
+    
+    private:
+        LDAPEntry *entry;
 };
 #endif //LDAP_SEARCH_RESULT_H