mapi_object_t support functions More...
#include <libmapi/libmapi.h>
mapi_object_t support functions
#define INVALID_HANDLE_VALUE 0xffffffff |
keep intern to this file
Referenced by mapi_object_is_invalid(), and mapi_object_release().
_PUBLIC_ enum MAPISTATUS mapi_object_bookmark_debug | ( | mapi_object_t * | obj_table | ) |
Dump bookmarks associated to a MAPI object table
obj_table | pointer on the MAPI object table |
References mapi_obj_bookmark::bin, mapi_obj_table::bookmark, global_mapi_ctx, mapi_obj_bookmark::index, mapi_obj_bookmark::next, OPENCHANGE_RETVAL_IF, and mapi_object::private_data.
enum MAPISTATUS mapi_object_bookmark_find | ( | mapi_object_t * | obj_table, | |
uint32_t | bkPosition, | |||
struct SBinary_short * | bin | |||
) |
Fetch a bookmark within a MAPI object table
obj_table | pointer on the MAPI object table | |
bkPosition | the bookmark position to find | |
bin | pointer on the Sbinary_short the function fills |
References mapi_obj_bookmark::bin, mapi_obj_table::bk_last, mapi_obj_table::bookmark, global_mapi_ctx, mapi_obj_bookmark::index, mapi_obj_bookmark::next, OPENCHANGE_RETVAL_IF, and mapi_object::private_data.
Referenced by FindRow(), and SeekRowBookmark().
_PUBLIC_ enum MAPISTATUS mapi_object_bookmark_get_count | ( | mapi_object_t * | obj_table, | |
uint32_t * | count | |||
) |
Retrieve the number of bookmarks stored in a MAPI object table
obj_table | pointer to the MAPI object table | |
count | pointer to the number of bookmarks to return |
References mapi_obj_table::bk_last, global_mapi_ctx, OPENCHANGE_RETVAL_IF, and mapi_object::private_data.
_PUBLIC_ enum MAPISTATUS mapi_object_copy | ( | mapi_object_t * | dst, | |
mapi_object_t * | src | |||
) |
Copy MAPI object
This function copies mapi_object data from source to destination.
dst | pointer on the destination MAPI object | |
src | pointer on the source MAPI object |
References mapi_object::handle, mapi_object::id, mapi_object::logon_id, OPENCHANGE_RETVAL_IF, mapi_object::private_data, and mapi_object::session.
_PUBLIC_ void mapi_object_debug | ( | mapi_object_t * | obj | ) |
Dump a MAPI object (for debugging)
obj | pointer on the MAPI object to dump out |
References mapi_object::handle, and mapi_object::id.
mapi_handle_t mapi_object_get_handle | ( | mapi_object_t * | obj | ) |
Retrieve the handle associated to a MAPI object
obj | pointer on the MAPI object to retrieve the handle from |
References mapi_object::handle.
Referenced by Abort(), AbortSubmit(), AddressTypes(), CloneStream(), CollapseRow(), CommitStream(), CopyFolder(), CopyProps(), CopyTo(), CopyToStream(), CreateAttach(), CreateBookmark(), CreateFolder(), CreateMessage(), DeleteAttach(), DeleteFolder(), DeleteMessage(), DeletePropertiesNoReplicate(), DeleteProps(), EmptyFolder(), ExpandRow(), FindRow(), FreeBookmark(), GetAttachmentTable(), GetCollapseState(), GetContentsTable(), GetHierarchyTable(), GetIdFromLongTermId(), GetIDsFromNames(), GetLocalReplicaIds(), GetLongTermIdFromId(), GetMessageStatus(), GetNamesFromIDs(), GetOwningServers(), GetPropList(), GetProps(), GetPropsAll(), GetReceiveFolder(), GetReceiveFolderTable(), GetRulesTable(), GetSearchCriteria(), GetStatus(), GetStoreState(), GetStreamSize(), GetTable(), GetTransportFolder(), GetValidAttach(), HardDeleteMessage(), HardDeleteMessagesAndSubfolders(), LockRegionStream(), mapi_object_is_invalid(), ModifyRecipients(), ModifyTable(), MoveCopyMessages(), MoveFolder(), OpenAttach(), OpenEmbeddedMessage(), OpenFolder(), OpenMessage(), OpenPublicFolderByName(), OpenStream(), ProcessNotification(), PublicFolderIsGhosted(), QueryColumns(), QueryNamedProperties(), QueryPosition(), QueryRows(), ReadRecipients(), ReadStream(), Release(), ReloadCachedInformation(), RemoveAllRecipients(), Reset(), Restrict(), SaveChangesAttachment(), SaveChangesMessage(), SeekRow(), SeekRowApprox(), SeekRowBookmark(), SeekStream(), SetCollapseState(), SetColumns(), SetMessageReadFlag(), SetMessageStatus(), SetPropertiesNoReplicate(), SetProps(), SetReadFlags(), SetReceiveFolder(), SetSearchCriteria(), SetSpooler(), SetStreamSize(), SortTable(), SpoolerLockMessage(), SubmitMessage(), Subscribe(), TransportNewMail(), TransportSend(), UnlockRegionStream(), WriteAndCommitStream(), and WriteStream().
_PUBLIC_ mapi_id_t mapi_object_get_id | ( | mapi_object_t * | obj | ) |
Retrieve an object ID for a given MAPI object
obj | pointer on the MAPI object to get the ID for |
References mapi_object::id.
Referenced by AbortSubmit(), CopyFolder(), CreateMessage(), GetOwningServers(), mapi_id_array_add_obj(), mapi_id_array_del_obj(), MoveFolder(), PublicFolderIsGhosted(), SetReceiveFolder(), SpoolerLockMessage(), Subscribe(), and TransportNewMail().
_PUBLIC_ enum MAPISTATUS mapi_object_get_logon_id | ( | mapi_object_t * | obj, | |
uint8_t * | logon_id | |||
) |
Retrieve the logon id for a given MAPI object
obj | pointer to the object to retrieve the logon id from | |
logon_id | pointer to a variable to store the logon id |
References mapi_object::logon_id.
Referenced by Abort(), AbortSubmit(), AddressTypes(), CloneStream(), CollapseRow(), CommitStream(), CopyFolder(), CopyProps(), CopyTo(), CopyToStream(), CreateAttach(), CreateBookmark(), CreateFolder(), CreateMessage(), DeleteAttach(), DeleteFolder(), DeleteMessage(), DeletePropertiesNoReplicate(), DeleteProps(), EmptyFolder(), ExpandRow(), FindRow(), FreeBookmark(), GetAttachmentTable(), GetCollapseState(), GetContentsTable(), GetHierarchyTable(), GetIdFromLongTermId(), GetIDsFromNames(), GetLocalReplicaIds(), GetLongTermIdFromId(), GetMessageStatus(), GetNamesFromIDs(), GetOwningServers(), GetPropList(), GetProps(), GetPropsAll(), GetReceiveFolder(), GetReceiveFolderTable(), GetRulesTable(), GetSearchCriteria(), GetStatus(), GetStoreState(), GetStreamSize(), GetTable(), GetTransportFolder(), GetValidAttach(), HardDeleteMessage(), HardDeleteMessagesAndSubfolders(), LockRegionStream(), ModifyRecipients(), ModifyTable(), MoveCopyMessages(), MoveFolder(), OpenAttach(), OpenEmbeddedMessage(), OpenFolder(), OpenMessage(), OpenPublicFolderByName(), OpenStream(), PublicFolderIsGhosted(), QueryColumns(), QueryNamedProperties(), QueryPosition(), QueryRows(), ReadRecipients(), ReadStream(), Release(), ReloadCachedInformation(), RemoveAllRecipients(), Reset(), Restrict(), SaveChangesAttachment(), SaveChangesMessage(), SeekRow(), SeekRowApprox(), SeekRowBookmark(), SeekStream(), SetCollapseState(), SetColumns(), SetMessageReadFlag(), SetMessageStatus(), SetPropertiesNoReplicate(), SetProps(), SetReadFlags(), SetReceiveFolder(), SetSearchCriteria(), SetSpooler(), SetStreamSize(), SortTable(), SpoolerLockMessage(), SubmitMessage(), Subscribe(), TransportNewMail(), TransportSend(), UnlockRegionStream(), WriteAndCommitStream(), and WriteStream().
_PUBLIC_ struct mapi_session* mapi_object_get_session | ( | mapi_object_t * | obj | ) | [read] |
Retrieve the session associated to the MAPI object
obj | the object to get the session for |
References mapi_object::session.
Referenced by Abort(), AbortSubmit(), AddressTypes(), AddUserPermission(), CloneStream(), CollapseRow(), CommitStream(), CopyFolder(), CopyProps(), CopyTo(), CopyToStream(), CreateAttach(), CreateBookmark(), CreateFolder(), CreateMessage(), DeleteAttach(), DeleteFolder(), DeleteMessage(), DeletePropertiesNoReplicate(), DeleteProps(), EmptyFolder(), ExpandRow(), FindRow(), FreeBookmark(), GetAttachmentTable(), GetCollapseState(), GetContentsTable(), GetHierarchyTable(), GetIdFromLongTermId(), GetIDsFromNames(), GetLocalReplicaIds(), GetLongTermIdFromId(), GetMessageStatus(), GetNamesFromIDs(), GetOwningServers(), GetPropList(), GetProps(), GetPropsAll(), GetReceiveFolder(), GetReceiveFolderTable(), GetRulesTable(), GetSearchCriteria(), GetStatus(), GetStoreState(), GetStreamSize(), GetTable(), GetTransportFolder(), GetUserFreeBusyData(), GetValidAttach(), HardDeleteMessage(), HardDeleteMessagesAndSubfolders(), IsFreeBusyConflict(), LockRegionStream(), Logoff(), ModifyRecipients(), ModifyTable(), ModifyUserPermission(), MoveCopyMessages(), MoveFolder(), OpenAttach(), OpenEmbeddedMessage(), OpenFolder(), OpenMessage(), OpenPublicFolderByName(), OpenStream(), PublicFolderIsGhosted(), QueryColumns(), QueryNamedProperties(), QueryPosition(), QueryRows(), ReadRecipients(), ReadStream(), Release(), ReloadCachedInformation(), RemoveAllRecipients(), RemoveUserPermission(), Reset(), Restrict(), SaveChangesAttachment(), SaveChangesMessage(), SeekRow(), SeekRowApprox(), SeekRowBookmark(), SeekStream(), SetCollapseState(), SetColumns(), SetMessageReadFlag(), SetMessageStatus(), SetPropertiesNoReplicate(), SetProps(), SetReadFlags(), SetReceiveFolder(), SetSearchCriteria(), SetSpooler(), SetStreamSize(), SortTable(), SpoolerLockMessage(), SubmitMessage(), Subscribe(), TransportNewMail(), TransportSend(), UnlockRegionStream(), WriteAndCommitStream(), and WriteStream().
_PUBLIC_ enum MAPISTATUS mapi_object_init | ( | mapi_object_t * | obj | ) |
Initialize MAPI object
This function is required to be called before any manipulation of this MAPI object.
obj | the object to initialize |
References global_mapi_ctx, and OPENCHANGE_RETVAL_IF.
Referenced by CreateFolder(), GetUserFreeBusyData(), ModifyUserPermission(), RemoveUserPermission(), and Subscribe().
int mapi_object_is_invalid | ( | mapi_object_t * | obj | ) |
Check if the supplied object has a valid handle
obj | pointer on the MAPI object to test |
References INVALID_HANDLE_VALUE, and mapi_object_get_handle().
_PUBLIC_ void mapi_object_release | ( | mapi_object_t * | obj | ) |
Release MAPI object
This function is required to be called when this MAPI object is no longer required.
obj | pointer on the MAPI object to release |
References mapi_object::handle, INVALID_HANDLE_VALUE, mapi_object::logon_id, mapi_session::logon_ids, mapi_object::private_data, Release(), mapi_object::session, and mapi_object::store.
Referenced by GetUserFreeBusyData(), Logoff(), ModifyUserPermission(), and RemoveUserPermission().
void mapi_object_set_handle | ( | mapi_object_t * | obj, | |
mapi_handle_t | handle | |||
) |
Associate a handle to a MAPI object
obj | pointer on the MAPI object on which handle has to be set | |
handle | the MAPI handle value |
References mapi_object::handle.
Referenced by CloneStream(), CreateAttach(), CreateFolder(), CreateMessage(), GetAttachmentTable(), GetContentsTable(), GetHierarchyTable(), GetRulesTable(), GetTable(), OpenAttach(), OpenEmbeddedMessage(), OpenFolder(), OpenMessage(), OpenPublicFolder(), OpenPublicFolderByName(), OpenStream(), OpenUserMailbox(), and Subscribe().
void mapi_object_set_id | ( | mapi_object_t * | obj, | |
mapi_id_t | id | |||
) |
Set the id for a given MAPI object
obj | pointer on the MAPI object to set the session for | |
id | Identifier to set to the object obj |
References mapi_object::id.
Referenced by CreateFolder(), OpenFolder(), and SaveChangesMessage().
_PUBLIC_ void mapi_object_set_logon_id | ( | mapi_object_t * | obj, | |
uint8_t | logon_id | |||
) |
Set the logon id for a given MAPI object
obj | pointer to the object to set the logon id for | |
logon_id | the logon identifier to associate to the MAPI object |
References mapi_object::logon_id.
Referenced by CloneStream(), CreateAttach(), CreateFolder(), CreateMessage(), GetAttachmentTable(), GetContentsTable(), GetHierarchyTable(), GetRulesTable(), GetTable(), OpenAttach(), OpenEmbeddedMessage(), OpenFolder(), OpenMessage(), OpenPublicFolder(), OpenPublicFolderByName(), OpenStream(), and OpenUserMailbox().
_PUBLIC_ void mapi_object_set_logon_store | ( | mapi_object_t * | obj | ) |
Mark a MAPI object as a store object
obj | pointer to the object to set the store boolean for |
References mapi_object::store.
Referenced by OpenPublicFolder(), and OpenUserMailbox().
_PUBLIC_ void mapi_object_set_session | ( | mapi_object_t * | obj, | |
struct mapi_session * | session | |||
) |
Set the session for a given MAPI object
obj | pointer on the object to set the session for | |
session | pointer on the MAPI session to associate to the MAPI object |
References mapi_object::session.
Referenced by CloneStream(), CreateAttach(), CreateFolder(), CreateMessage(), GetAttachmentTable(), GetContentsTable(), GetHierarchyTable(), GetRulesTable(), GetTable(), OpenAttach(), OpenEmbeddedMessage(), OpenFolder(), OpenMessage(), OpenPublicFolder(), OpenPublicFolderByName(), OpenStream(), OpenUserMailbox(), and Subscribe().
void mapi_object_table_init | ( | TALLOC_CTX * | mem_ctx, | |
mapi_object_t * | obj_table | |||
) |
Initialize MAPI object private data to store a MAPI object table
mem_ctx | pointer on the memory context | |
obj_table | pointer on the MAPI object |
References mapi_obj_table::bk_last, mapi_obj_table::bookmark, mapi_object::private_data, and mapi_obj_table::proptags.
Referenced by GetContentsTable(), GetHierarchyTable(), GetRulesTable(), and GetTable().
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |