Please find attached a patch that updates the API documentation.
This has the minor fix for the error value change as well.
Brad
Index: libmapi/property.c
===================================================================
--- libmapi/property.c (revision 354)
+++ libmapi/property.c (working copy)
@@ -24,6 +24,12 @@
#include <gen_ndr/ndr_exchange.h>
#include <param.h>
+/**
+ \file property.c
+
+ \brief Functions for manipulating MAPI properties
+ */
+
_PUBLIC_ struct SPropTagArray *set_SPropTagArray(TALLOC_CTX *mem_ctx,
uint32_t prop_nb, ...)
{
@@ -46,13 +52,27 @@
return SPropTag;
}
+/**
+ \details Add a property tag to an existing properties array
+
+ \param mem_ctx talloc memory context to use for allocation
+ \param SPropTagArray existing properties array to add to
+ \param aulPropTag the property tag to add
+
+ \return MAPI_E_SUCCESS on success, otherwise -1.
+
+ \note Developers should call GetLastError() to retrieve the last
+ MAPI error code. Possible MAPI error codes are:
+ - MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
+ - MAPI_E_INVALID_PARAMETER: SPropTagArray parameter is not correctly set
+*/
_PUBLIC_ enum MAPISTATUS SPropTagArray_add(TALLOC_CTX *mem_ctx,
struct SPropTagArray *SPropTagArray,
uint32_t aulPropTag)
{
MAPI_RETVAL_IF(!mem_ctx, MAPI_E_NOT_INITIALIZED, NULL);
MAPI_RETVAL_IF(!SPropTagArray, MAPI_E_INVALID_PARAMETER, NULL);
- MAPI_RETVAL_IF(!SPropTagArray->cValues, MAPI_E_NOT_INITIALIZED, NULL);
+ MAPI_RETVAL_IF(!SPropTagArray->cValues, MAPI_E_INVALID_PARAMETER, NULL);
SPropTagArray->cValues += 1;
SPropTagArray->aulPropTag = talloc_realloc(mem_ctx, SPropTagArray->aulPropTag,
Index: libmapi/IXPLogon.c
===================================================================
--- libmapi/IXPLogon.c (revision 354)
+++ libmapi/IXPLogon.c (working copy)
@@ -24,6 +24,8 @@
/**
\file IXPLogon.c
+
+ \brief Transport provider status information
*/
@@ -41,7 +43,7 @@
\note Developers should call GetLastError() to retrieve the last
MAPI error code. Possible MAPI error codes are:
- MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
- - MAPI_E_INVALID_PARAMETER: obj is not initialized
+ - MAPI_E_INVALID_PARAMETER: obj_store is not initialized
- MAPI_E_CALL_FAILED: A network problem was encountered during the
transaction
Index: libmapi/mapidump.c
===================================================================
--- libmapi/mapidump.c (revision 354)
+++ libmapi/mapidump.c (working copy)
@@ -21,6 +21,12 @@
#include <libmapi/mapidump.h>
#include <libmapi/proto_private.h>
+/**
+ \file mapidump.c
+
+ \brief Functions for displaying various data structures, mainly for debugging
+ */
+
_PUBLIC_ void mapidump_SPropValue(struct SPropValue lpProp, const char *sep)
{
const char *proptag;
@@ -190,6 +196,16 @@
talloc_free(mem_ctx);
}
+/**
+ \details This function dumps the properties relating to a message to standard output
+
+ The expected way to obtain the properties array is to use OpenMessage() to obtain the
+ message object, then to use GetPropsAll() to obtain all the properties.
+
+ \param properties array of message properties
+
+ \sa mapidump_appointment, mapidump_contact, mapidump_task, mapidump_note
+*/
_PUBLIC_ void mapidump_message(struct mapi_SPropValue_array *properties)
{
const char *msgid;
@@ -267,6 +283,17 @@
}
}
+/**
+ \details This function dumps the properties relating to an appointment to standard output
+
+ The expected way to obtain the properties array is to use OpenMessage() to obtain the
+ appointment object, then to use GetPropsAll() to obtain all the properties.
+
+ \param properties array of appointment properties
+ \param id identification to display for the appointment (can be NULL)
+
+ \sa mapidump_message, mapidump_contact, mapidump_task, mapidump_note
+*/
_PUBLIC_ void mapidump_appointment(struct mapi_SPropValue_array *properties, const char *id)
{
const struct mapi_SLPSTRArray *contacts = NULL;
@@ -318,6 +345,18 @@
}
}
+/**
+ \details This function dumps the properties relating to a contact (address book entry)
+ to standard output
+
+ The expected way to obtain the properties array is to use OpenMessage() to obtain the
+ contact object, then to use GetPropsAll() to obtain all the properties.
+
+ \param properties array of contact properties
+ \param id identification to display for the contact (can be NULL)
+
+ \sa mapidump_message, mapidump_appointment, mapidump_task, mapidump_note
+*/
_PUBLIC_ void mapidump_contact(struct mapi_SPropValue_array *properties, const char *id)
{
const char *card_name =NULL;
@@ -437,6 +476,18 @@
return NULL;
}
+/**
+ \details This function dumps the properties relating to a task (to-do list entry)
+ to standard output
+
+ The expected way to obtain the properties array is to use OpenMessage() to obtain the
+ task object, then to use GetPropsAll() to obtain all the properties.
+
+ \param properties array of task properties
+ \param id identification to display for the task (can be NULL)
+
+ \sa mapidump_message, mapidump_appointment, mapidump_contact, mapidump_note
+*/
_PUBLIC_ void mapidump_task(struct mapi_SPropValue_array *properties, const char *id)
{
const struct mapi_SLPSTRArray *contacts = NULL;
@@ -499,6 +550,17 @@
}
}
+/**
+ \details This function dumps the properties relating to a note to standard output
+
+ The expected way to obtain the properties array is to use OpenMessage() to obtain the
+ note object, then to use GetPropsAll() to obtain all the properties.
+
+ \param properties array of note properties
+ \param id identification to display for the note (can be NULL)
+
+ \sa mapidump_message, mapidump_appointment, mapidump_contact, mapidump_task
+*/
_PUBLIC_ void mapidump_note(struct mapi_SPropValue_array *properties, const char *id)
{
const char *subject = NULL;
_______________________________________________
devel mailing list
[email protected]
http://mailman.openchange.org/listinfo/devel
