Containers and tables related operations. More...
Functions | |
_PUBLIC_ enum MAPISTATUS | GetContentsTable (mapi_object_t *obj_container, mapi_object_t *obj_table, uint8_t TableFlags, uint32_t *RowCount) |
_PUBLIC_ enum MAPISTATUS | GetHierarchyTable (mapi_object_t *obj_container, mapi_object_t *obj_table, uint8_t TableFlags, uint32_t *RowCount) |
_PUBLIC_ enum MAPISTATUS | GetPermissionsTable (mapi_object_t *obj_container, uint8_t flags, mapi_object_t *obj_table) |
_PUBLIC_ enum MAPISTATUS | GetRulesTable (mapi_object_t *obj_folder, mapi_object_t *obj_table, uint8_t TableFlags) |
_PUBLIC_ enum MAPISTATUS | GetSearchCriteria (mapi_object_t *obj_container, struct mapi_SRestriction *res, uint32_t *SearchFlags, uint16_t *FolderIdCount, uint64_t **FolderIds) |
_PUBLIC_ enum MAPISTATUS | ModifyPermissions (mapi_object_t *obj_table, uint8_t flags, struct mapi_PermissionsData *permsdata) |
_PUBLIC_ enum MAPISTATUS | SetSearchCriteria (mapi_object_t *obj_container, struct mapi_SRestriction *res, uint32_t SearchFlags, mapi_id_array_t *lpContainerList) |
Containers and tables related operations.
_PUBLIC_ enum MAPISTATUS GetContentsTable | ( | mapi_object_t * | obj_container, |
mapi_object_t * | obj_table, | ||
uint8_t | TableFlags, | ||
uint32_t * | RowCount | ||
) |
Returns a pointer to a container's table object
This function takes a pointer to a container object and returns a pointer to its associated contents
obj_container | the object to get the contents of |
obj_table | the resulting table containing the container's contents. |
TableFlags | flags controlling the type of table |
RowCount | the number of rows in the hierarchy table |
TableFlags possible values:
Developers can either set RowCount to a valid pointer on uint32_t or set it to NULL. In this last case, GetHierarchyTable won't return any value to the calling function.
References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), mapi_object_set_handle(), mapi_object_set_logon_id(), mapi_object_set_session(), mapi_object_table_init(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.
Referenced by GetUserFreeBusyData().
_PUBLIC_ enum MAPISTATUS GetHierarchyTable | ( | mapi_object_t * | obj_container, |
mapi_object_t * | obj_table, | ||
uint8_t | TableFlags, | ||
uint32_t * | RowCount | ||
) |
Returns a pointer to a container's table object
This function takes a pointer to a container object and returns a pointer to its associated hierarchy table
obj_container | the object to get the contents of |
obj_table | the resulting table containing the container's hierarchy |
TableFlags | flags controlling the type of table |
RowCount | the number of rows in the hierarchy table |
TableFlags possible values:
Developers can either set RowCount to a valid pointer on uint32_t or set it to NULL. In this last case, GetHierarchyTable won't return any value to the calling function.
References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), mapi_object_set_handle(), mapi_object_set_logon_id(), mapi_object_set_session(), mapi_object_table_init(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.
Referenced by GetUserFreeBusyData().
_PUBLIC_ enum MAPISTATUS GetPermissionsTable | ( | mapi_object_t * | obj_container, |
uint8_t | flags, | ||
mapi_object_t * | obj_table | ||
) |
Returns a pointer to the permission's table object.
This function takes a pointer to a container object and returns a pointer to its associated permission table
obj_container | the object to get the contents of |
flags | any special flags to pass |
obj_table | the resulting table containing the container's permissions |
The only meaningful value for flags is IncludeFreeBusy (0x02). This should be set when getting permissions on the Calendar folder when using Exchange 2007 and later. It should not be set in other situations.
References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), mapi_object_set_handle(), mapi_object_set_logon_id(), mapi_object_set_session(), mapi_object_table_init(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.
Referenced by ModifyUserPermission(), and RemoveUserPermission().
_PUBLIC_ enum MAPISTATUS GetRulesTable | ( | mapi_object_t * | obj_folder, |
mapi_object_t * | obj_table, | ||
uint8_t | TableFlags | ||
) |
Gets the rules table of a folder
obj_folder | the folder we want to retrieve the rules table from |
obj_table | the rules table |
TableFlags | bitmask associated to the rules table |
Possible values for TableFlags:
References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), mapi_object_set_handle(), mapi_object_set_logon_id(), mapi_object_set_session(), mapi_object_table_init(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS GetSearchCriteria | ( | mapi_object_t * | obj_container, |
struct mapi_SRestriction * | res, | ||
uint32_t * | SearchFlags, | ||
uint16_t * | FolderIdCount, | ||
uint64_t ** | FolderIds | ||
) |
Obtains the search criteria for a container
obj_container | the object we retrieve search criteria from |
res | pointer to a mapi_SRestriction structure defining the search criteria |
SearchFlags | bitmask of flags that controls how the search is performed |
FolderIdCount | number of FolderIds entries |
FolderIds | pointer to a list of identifiers representing containers included in the search |
References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS ModifyPermissions | ( | mapi_object_t * | obj_table, |
uint8_t | flags, | ||
struct mapi_PermissionsData * | permsdata | ||
) |
Modify the entries of a permission table
This function takes a pointer to a table object, a list of entries to modify and alter the permission table of its associated container. This function can be used to add, modify or remove permissions.
obj_table | the table containing the container's permissions |
flags | any special flags to use |
permsdata | the list of permissions table entries to modify |
Possible values for flags:
References emsmdb_transaction_wrapper(), get_mapi_property_size(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.
Referenced by AddUserPermission(), ModifyUserPermission(), and RemoveUserPermission().
_PUBLIC_ enum MAPISTATUS SetSearchCriteria | ( | mapi_object_t * | obj_container, |
struct mapi_SRestriction * | res, | ||
uint32_t | SearchFlags, | ||
mapi_id_array_t * | lpContainerList | ||
) |
Establishes search criteria for the container
obj_container | the object we apply search criteria to |
res | pointer to a mapi_SRestriction structure defining the search criteria |
SearchFlags | bitmask of flags that controls how the search is performed |
lpContainerList | pointer to a list of identifiers representing containers to be included in the search |
SearchFlags can take the following values:
References mapi_id_array::count, emsmdb_transaction_wrapper(), get_mapi_SRestriction_size(), mapi_id_array_get(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |