libmapi/mapidump.c File Reference

Functions for displaying various data structures, mainly for debugging. More...

#include <libmapi/libmapi.h>

Functions

_PUBLIC_ void mapidump_appointment (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_contact (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_message (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_note (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_task (struct mapi_SPropValue_array *properties, const char *id)

Detailed Description

Functions for displaying various data structures, mainly for debugging.


Function Documentation

_PUBLIC_ void mapidump_appointment ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

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.

Parameters:
properties array of appointment properties
id identification to display for the appointment (can be NULL)
See also:
mapidump_message, mapidump_contact, mapidump_task, mapidump_note
Examples:
fetchappointment.c.
_PUBLIC_ void mapidump_contact ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

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.

Parameters:
properties array of contact properties
id identification to display for the contact (can be NULL)
See also:
mapidump_message, mapidump_appointment, mapidump_task, mapidump_note
_PUBLIC_ void mapidump_message ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

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.

Parameters:
properties array of message properties
id identification to display for the message (can be NULL)
See also:
mapidump_appointment, mapidump_contact, mapidump_task, mapidump_note
Examples:
fetchmail.c.
_PUBLIC_ void mapidump_note ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

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.

Parameters:
properties array of note properties
id identification to display for the note (can be NULL)
See also:
mapidump_message, mapidump_appointment, mapidump_contact, mapidump_task
_PUBLIC_ void mapidump_task ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

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.

Parameters:
properties array of task properties
id identification to display for the task (can be NULL)
See also:
mapidump_message, mapidump_appointment, mapidump_contact, mapidump_note

Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/