Containers and tables related operations. More...
#include <libmapi/libmapi.h>
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 | 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 | GetTable (mapi_object_t *obj_container, mapi_object_t *obj_table) |
_PUBLIC_ enum MAPISTATUS | ModifyTable (mapi_object_t *obj_table, struct mapi_SRowList *rowList) |
_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(), 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(), and mapi_object_table_init().
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(), 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(), and mapi_object_table_init().
Referenced by GetUserFreeBusyData().
_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(), 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(), and mapi_object_table_init().
_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(), mapi_object_get_handle(), mapi_object_get_logon_id(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS GetTable | ( | mapi_object_t * | obj_container, | |
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 | |
obj_table | the resulting table containing the container's permissions |
References emsmdb_transaction(), 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(), and mapi_object_table_init().
Referenced by ModifyUserPermission(), and RemoveUserPermission().
_PUBLIC_ enum MAPISTATUS ModifyTable | ( | mapi_object_t * | obj_table, | |
struct mapi_SRowList * | rowList | |||
) |
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 | |
rowList | the list of table entries to modify |
References emsmdb_transaction(), mapi_object_get_handle(), mapi_object_get_logon_id(), and mapi_object_get_session().
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 | |||
) |
Etablishes search criteria for the container
obj_container | the object we apply search criteria on | |
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 emsmdb_transaction(), get_mapi_SRestriction_size(), mapi_id_array_get(), mapi_object_get_handle(), mapi_object_get_logon_id(), and mapi_object_get_session().
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |