libmapi/property.c File Reference

Functions for manipulating MAPI properties. More...

#include <libmapi/libmapi.h>

Functions
_PUBLIC_ struct GlobalObjectId *	get_GlobalObjectId (TALLOC_CTX *mem_ctx, struct Binary_r *bin)
_PUBLIC_ struct RecurrencePattern *	get_RecurrencePattern (TALLOC_CTX *mem_ctx, struct Binary_r *bin)
_PUBLIC_ struct TimeZoneStruct *	get_TimeZoneStruct (TALLOC_CTX *mem_ctx, struct Binary_r *bin)
_PUBLIC_ enum MAPISTATUS	SPropTagArray_add (TALLOC_CTX *mem_ctx, struct SPropTagArray *SPropTagArray, uint32_t aulPropTag)
_PUBLIC_ enum MAPISTATUS	SRow_addprop (struct SRow *aRow, struct SPropValue SPropValue)
_PUBLIC_ uint32_t	SRowSet_propcpy (TALLOC_CTX *mem_ctx, struct SRowSet *SRowSet, struct SPropValue SPropValue)

---

Detailed Description

Functions for manipulating MAPI properties.

---

Function Documentation

_PUBLIC_ struct GlobalObjectId* get_GlobalObjectId	(	TALLOC_CTX *	mem_ctx,
		struct Binary_r *	bin
	)			[read]

Retrieve a GlobalObjectId structure from a binary blob

Parameters:

	mem_ctx	pointer to the memory context
	bin	pointer to the Binary_r structure with raw GlobalObjectId data

Returns:

Allocated GlobalObjectId structure on success, otherwise NULL

Note:

Developers must free the allocated GlobalObjectId when finished.

_PUBLIC_ struct RecurrencePattern* get_RecurrencePattern	(	TALLOC_CTX *	mem_ctx,
		struct Binary_r *	bin
	)			[read]

Retrieve a RecurrencePattern structure from a binary blob

Parameters:

	mem_ctx	pointer to the memory context
	bin	pointer to the Binary_r structure with non-mapped reccurrence data

Returns:

Allocated RecurrencePattern structure on success, otherwise NULL

Note:

Developers must free the allocated RecurrencePattern when finished.

_PUBLIC_ struct TimeZoneStruct* get_TimeZoneStruct	(	TALLOC_CTX *	mem_ctx,
		struct Binary_r *	bin
	)			[read]

Retrieve a TimeZoneStruct structure from a binary blob

Parameters:

	mem_ctx	pointer to the memory context
	bin	pointer to the Binary_r structure with raw TimeZoneStruct data

Returns:

Allocated TimeZoneStruct structure on success, otherwise NULL

Note:

Developers must free the allocated TimeZoneStruct when finished.

_PUBLIC_ enum MAPISTATUS SPropTagArray_add	(	TALLOC_CTX *	mem_ctx,
		struct SPropTagArray *	SPropTagArray,
		uint32_t	aulPropTag
	)

Add a property tag to an existing properties array

Parameters:

	mem_ctx	talloc memory context to use for allocation
	SPropTagArray	existing properties array to add to
	aulPropTag	the property tag to add

Returns:

MAPI_E_SUCCESS on success, otherwise MAPI error.

Note:

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

Referenced by OpenEmbeddedMessage(), and OpenMessage().

_PUBLIC_ enum MAPISTATUS SRow_addprop	(	struct SRow *	aRow,
		struct SPropValue SPropValue
	)

add a SPropValue structure to a SRow array

Parameters:

	aRow	pointer to the SRow array where SPropBalue should be appended
	SPropValue	reference to the SPropValue structure to add to aRow

Returns:

MAPI_E_SUCCESS on success, otherwise MAPI_E_INVALID_PARAMETER.

Referenced by OpenEmbeddedMessage(), OpenMessage(), and SetRecipientType().

_PUBLIC_ uint32_t SRowSet_propcpy	(	TALLOC_CTX *	mem_ctx,
		struct SRowSet *	SRowSet,
		struct SPropValue SPropValue
	)

Append a SPropValue structure to given SRowSet

Parameters:

	mem_ctx	pointer to the memory context
	SRowSet	pointer to the SRowSet array to update
	SPropValue	the SPropValue to append within SRowSet

Returns:

0 on success, otherwise 1