Merge remote-tracking branch 'origin/mdb.master'

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

diff --git a/contrib/ldapc++/src/LDAPExtResult.h b/contrib/ldapc++/src/LDAPExtResult.h
index 1f7aeb63a0fda562aa8d93aa577e018afc0a3192..d4d879416bb5730f419a22e85da959c66b78cec9 100644 (file)
--- a/contrib/ldapc++/src/LDAPExtResult.h
+++ b/contrib/ldapc++/src/LDAPExtResult.h
@@ -1,5 +1,6 @@
+// $OpenLDAP$
 /*
- * Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 2000-2013 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 
@@ -8,20 +9,42 @@
 
 #include <ldap.h>
 
-class LDAPResult;
+#include <LDAPResult.h>
+
 class LDAPRequest;
 
+/**
+ * Object of this class are created by the LDAPMsg::create method if
+ * results for an Extended Operation were returned by a LDAP server.
+ */
 class LDAPExtResult : public LDAPResult {
     public :
+        /**
+         * Constructor that creates an LDAPExtResult-object from the C-API
+         * structures
+         */
         LDAPExtResult(const LDAPRequest* req, LDAPMessage* msg);
+
+        /**
+         * The Destructor
+         */
         virtual ~LDAPExtResult();
 
-        const string& getResponseOid() const;
-        const string& getResponse() const;
+        /**
+         * @returns The OID of the Extended Operation that has returned
+         *          this result. 
+         */
+        const std::string& getResponseOid() const;
+
+        /**
+         * @returns If the result contained data this method will return
+         *          the data to the caller as a std::string.
+         */
+        const std::string& getResponse() const;
 
     private:
-        string m_oid;
-        string m_data;
+        std::string m_oid;
+        std::string m_data;
 };
 
 #endif // LDAP_EXT_RESULT_H