mapi_nameid convenience API More...
#include <libmapi/libmapi.h>
Functions | |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_canonical_add (struct mapi_nameid *mapi_nameid, uint32_t proptag) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_custom_lid_add (struct mapi_nameid *mapi_nameid, uint16_t lid, uint16_t propType, const char *OLEGUID) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_custom_string_add (struct mapi_nameid *mapi_nameid, const char *Name, uint16_t propType, const char *OLEGUID) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_GetIDsFromNames (struct mapi_nameid *mapi_nameid, mapi_object_t *obj, struct SPropTagArray *SPropTagArray) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_lid_add (struct mapi_nameid *mapi_nameid, uint16_t lid, const char *OLEGUID) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_lid_lookup (uint16_t lid, const char *OLEGUID, uint16_t *propType) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_lookup_SPropTagArray (struct mapi_nameid *nameid, struct SPropTagArray *SPropTagArray) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_lookup_SPropValue (struct mapi_nameid *mapi_nameid, struct SPropValue *lpProps, unsigned long PropCount) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_map_SPropTagArray (struct mapi_nameid *mapi_nameid, struct SPropTagArray *SPropTagArray, struct SPropTagArray *SPropTagArray2) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_map_SPropValue (struct mapi_nameid *mapi_nameid, struct SPropValue *lpProps, uint32_t PropCount, struct SPropTagArray *SPropTagArray) |
_PUBLIC_ struct mapi_nameid * | mapi_nameid_new (TALLOC_CTX *mem_ctx) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_OOM_add (struct mapi_nameid *mapi_nameid, const char *OOM, const char *OLEGUID) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_OOM_lookup (const char *OOM, const char *OLEGUID, uint16_t *propType) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_SPropTagArray (struct mapi_nameid *mapi_nameid, struct SPropTagArray *SPropTagArray) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_string_add (struct mapi_nameid *mapi_nameid, const char *Name, const char *OLEGUID) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_string_lookup (const char *Name, const char *OLEGUID, uint16_t *propType) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_unmap_SPropTagArray (struct mapi_nameid *mapi_nameid, struct SPropTagArray *SPropTagArray) |
_PUBLIC_ enum MAPISTATUS | mapi_nameid_unmap_SPropValue (struct mapi_nameid *mapi_nameid, struct SPropValue *lpProps, uint32_t PropCount) |
mapi_nameid convenience API
_PUBLIC_ enum MAPISTATUS mapi_nameid_canonical_add | ( | struct mapi_nameid * | mapi_nameid, | |
uint32_t | proptag | |||
) |
Add a mapi_nameid entry given its canonical property tag
mapi_nameid | the structure where results are stored | |
proptag | the canonical property tag we are searching |
References mapi_nameid::count, mapi_nameid::entries, mapi_nameid::nameid, and OPENCHANGE_RETVAL_IF.
Referenced by mapi_nameid_lookup_SPropTagArray(), and mapi_nameid_lookup_SPropValue().
_PUBLIC_ enum MAPISTATUS mapi_nameid_custom_lid_add | ( | struct mapi_nameid * | mapi_nameid, | |
uint16_t | lid, | |||
uint16_t | propType, | |||
const char * | OLEGUID | |||
) |
Register and add a custom MNID_ID named property given its lid, proptype and OLEGUID.
mapi_nameid | the structure where results are stored | |
lid | the light ID of the name property (used by MNID_ID named props only) | |
propType | the named property type | |
OLEGUID | the property set this entry belongs to |
References mapi_nameid::count, mapi_nameid::entries, mapi_nameid_tags::lid, mapi_nameid::nameid, mapi_nameid_tags::OLEGUID, OPENCHANGE_RETVAL_IF, mapi_nameid_tags::propType, and mapi_nameid_tags::ulKind.
_PUBLIC_ enum MAPISTATUS mapi_nameid_custom_string_add | ( | struct mapi_nameid * | mapi_nameid, | |
const char * | Name, | |||
uint16_t | propType, | |||
const char * | OLEGUID | |||
) |
Register and add a custom MNID_STRING named property given its string, proptype and OLEGUID.
mapi_nameid | the structure where results are stored | |
Name | the property name (used by MNID_STRING named props only) | |
propType | the named property type | |
OLEGUID | the property set this entry belongs to |
References mapi_nameid::count, mapi_nameid::entries, mapi_nameid_tags::Name, mapi_nameid::nameid, mapi_nameid_tags::OLEGUID, OPENCHANGE_RETVAL_IF, mapi_nameid_tags::propType, and mapi_nameid_tags::ulKind.
_PUBLIC_ enum MAPISTATUS mapi_nameid_GetIDsFromNames | ( | struct mapi_nameid * | mapi_nameid, | |
mapi_object_t * | obj, | |||
struct SPropTagArray * | SPropTagArray | |||
) |
Lookup named properties (MNID_STRING) and return their mapped proptags
This convenient function calls GetIDsFromNames() and returns property tags with their real property type.
References mapi_nameid::count, mapi_nameid::entries, GetIDsFromNames(), GetLastError(), mapi_nameid::nameid, OPENCHANGE_RETVAL_IF, and mapi_nameid_tags::propType.
_PUBLIC_ enum MAPISTATUS mapi_nameid_lid_add | ( | struct mapi_nameid * | mapi_nameid, | |
uint16_t | lid, | |||
const char * | OLEGUID | |||
) |
Add a mapi_nameid entry given its lid and OLEGUID (MNID_ID)
mapi_nameid | the structure where results are stored | |
lid | the light ID of the name property (used by MNID_ID named props only) | |
OLEGUID | the property set this entry belongs to |
References mapi_nameid::count, mapi_nameid::entries, mapi_nameid::nameid, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS mapi_nameid_lid_lookup | ( | uint16_t | lid, | |
const char * | OLEGUID, | |||
uint16_t * | propType | |||
) |
Search for a given lid,OLEGUID couple and return the associated propType.
lid | the named property light ID | |
OLEGUID | the named property GUID for this entry | |
propType | pointer on returned named property type |
References OPENCHANGE_RETVAL_ERR, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS mapi_nameid_lookup_SPropTagArray | ( | struct mapi_nameid * | nameid, | |
struct SPropTagArray * | SPropTagArray | |||
) |
Loop over SPropTagArray and look for canonical named property tags we can add to the nameid structure.
nameid | the structure where results are stored | |
SPropTagArray | the array of property tags where to look for canonical named property tags. |
References mapi_nameid_canonical_add(), and OPENCHANGE_RETVAL_IF.
Referenced by GetProps().
_PUBLIC_ enum MAPISTATUS mapi_nameid_lookup_SPropValue | ( | struct mapi_nameid * | mapi_nameid, | |
struct SPropValue * | lpProps, | |||
unsigned long | PropCount | |||
) |
Loop over lpProps and look for canonical named property tags we can add to the nameid structure.
mapi_nameid | the structure where results are stored | |
lpProps | pointer on a SPropValue structure with the property tags where to look for canonical named property tags | |
PropCount | count of lpProps elemense |
References mapi_nameid_canonical_add(), and OPENCHANGE_RETVAL_IF.
Referenced by SetPropertiesNoReplicate(), and SetProps().
_PUBLIC_ enum MAPISTATUS mapi_nameid_map_SPropTagArray | ( | struct mapi_nameid * | mapi_nameid, | |
struct SPropTagArray * | SPropTagArray, | |||
struct SPropTagArray * | SPropTagArray2 | |||
) |
Replace named property tags in SPropTagArray with the property ID Exchange expects and stored in SPropTagArray2.
mapi_nameid | the structure where results are stored | |
SPropTagArray | the array of property tags with original property tags | |
SPropTagArray2 | the array of named property tags resolved with GetIDsFromNames |
References mapi_nameid::count, mapi_nameid::entries, OPENCHANGE_RETVAL_IF, mapi_nameid_tags::position, mapi_nameid_tags::proptag, and mapi_nameid_tags::propType.
Referenced by GetProps().
_PUBLIC_ enum MAPISTATUS mapi_nameid_map_SPropValue | ( | struct mapi_nameid * | mapi_nameid, | |
struct SPropValue * | lpProps, | |||
uint32_t | PropCount, | |||
struct SPropTagArray * | SPropTagArray | |||
) |
Replace named property tags in the SPropValue array with the property ID Exchange expects and stored in SPropTagArray.
mapi_nameid | the structure where results are stored | |
lpProps | pointer on a SPropValue structure with property tags and values | |
PropCount | count of lpProps elements | |
SPropTagArray | the array of named property tags resolved with GetIDsFromNames |
References mapi_nameid::count, mapi_nameid::entries, OPENCHANGE_RETVAL_IF, mapi_nameid_tags::position, mapi_nameid_tags::proptag, and mapi_nameid_tags::propType.
Referenced by SetPropertiesNoReplicate(), and SetProps().
_PUBLIC_ struct mapi_nameid* mapi_nameid_new | ( | TALLOC_CTX * | mem_ctx | ) | [read] |
Create a new mapi_nameid structure
mem_ctx | memory context to use for allocation |
References mapi_nameid::count, mapi_nameid::entries, and mapi_nameid::nameid.
Referenced by GetProps(), SetPropertiesNoReplicate(), and SetProps().
_PUBLIC_ enum MAPISTATUS mapi_nameid_OOM_add | ( | struct mapi_nameid * | mapi_nameid, | |
const char * | OOM, | |||
const char * | OLEGUID | |||
) |
Add a mapi_nameid entry given its OOM and OLEGUID (MNID_ID|MNID_STRING)
mapi_nameid | the structure where results are stored | |
OOM | the Outlook Object Model matching string | |
OLEGUID | the property set this entry belongs to |
References mapi_nameid::count, mapi_nameid::entries, mapi_nameid::nameid, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS mapi_nameid_OOM_lookup | ( | const char * | OOM, | |
const char * | OLEGUID, | |||
uint16_t * | propType | |||
) |
Search for a given OOM,OLEGUID couple and return the associated propType.
OOM | The Outlook Object Model | |
OLEGUID | the named property GUID for this entry | |
propType | pointer on returned named property type |
References OPENCHANGE_RETVAL_ERR, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS mapi_nameid_SPropTagArray | ( | struct mapi_nameid * | mapi_nameid, | |
struct SPropTagArray * | SPropTagArray | |||
) |
set SPropTagArray ulPropTag property types from mapi_nameid returned by GetIDsFromNames()
mapi_nameid | the structure where results are stored | |
SPropTagArray | the array of property tags returned by previous call to GetIDsFromNames() |
References mapi_nameid::count, mapi_nameid::entries, OPENCHANGE_RETVAL_IF, and mapi_nameid_tags::propType.
_PUBLIC_ enum MAPISTATUS mapi_nameid_string_add | ( | struct mapi_nameid * | mapi_nameid, | |
const char * | Name, | |||
const char * | OLEGUID | |||
) |
Add a mapi_nameid entry given its Name and OLEGUID (MNID_STRING)
mapi_nameid | the structure where results are stored | |
Name | the property name (used by MNID_STRING named props only) | |
OLEGUID | the property set this entry belongs to |
References mapi_nameid::count, mapi_nameid::entries, mapi_nameid::nameid, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS mapi_nameid_string_lookup | ( | const char * | Name, | |
const char * | OLEGUID, | |||
uint16_t * | propType | |||
) |
Search for a given Name,OLEGUID couple and return the associated propType.
Name | the named property name | |
OLEGUID | the named property GUID for this entry | |
propType | pointer on returned named property type |
References OPENCHANGE_RETVAL_ERR, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS mapi_nameid_unmap_SPropTagArray | ( | struct mapi_nameid * | mapi_nameid, | |
struct SPropTagArray * | SPropTagArray | |||
) |
Restore the original SPropTagArray array with the property tags saved in the mapi_nameid structure.
mapi_nameid | the structure where results are stored | |
SPropTagArray | the array of property tags with original property tags |
References mapi_nameid::count, mapi_nameid::entries, OPENCHANGE_RETVAL_IF, mapi_nameid_tags::position, and mapi_nameid_tags::proptag.
Referenced by GetProps().
_PUBLIC_ enum MAPISTATUS mapi_nameid_unmap_SPropValue | ( | struct mapi_nameid * | mapi_nameid, | |
struct SPropValue * | lpProps, | |||
uint32_t | PropCount | |||
) |
Restore the original SPropValue array with the property tags saved in the mapi_nameid structure.
mapi_nameid | the structure where results are stored | |
lpProps | the array of SPropValue structures with original property tags | |
PropCount | count of lpProps elements |
References mapi_nameid::count, mapi_nameid::entries, OPENCHANGE_RETVAL_IF, mapi_nameid_tags::position, and mapi_nameid_tags::proptag.
Referenced by SetPropertiesNoReplicate(), and SetProps().
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |