public OCPF API More...
#include "libocpf/ocpf.h"
Functions | |
enum MAPISTATUS | ocpf_clear_props (uint32_t context_id) |
_PUBLIC_ int | ocpf_del_context (uint32_t context_id) |
_PUBLIC_ enum MAPISTATUS | ocpf_get_recipients (TALLOC_CTX *mem_ctx, uint32_t context_id, struct SRowSet **SRowSet) |
_PUBLIC_ struct SPropValue * | ocpf_get_SPropValue (uint32_t context_id, uint32_t *cValues) |
_PUBLIC_ int | ocpf_init (void) |
_PUBLIC_ int | ocpf_new_context (const char *filename, uint32_t *context_id, uint8_t flags) |
_PUBLIC_ enum MAPISTATUS | ocpf_OpenFolder (uint32_t context_id, mapi_object_t *obj_store, mapi_object_t *obj_folder) |
_PUBLIC_ int | ocpf_parse (uint32_t context_id) |
_PUBLIC_ int | ocpf_release (void) |
_PUBLIC_ enum MAPISTATUS | ocpf_set_Recipients (TALLOC_CTX *mem_ctx, uint32_t context_id, mapi_object_t *obj_message) |
_PUBLIC_ enum MAPISTATUS | ocpf_set_SPropValue (TALLOC_CTX *mem_ctx, uint32_t context_id, mapi_object_t *obj_folder, mapi_object_t *obj_message) |
public OCPF API
enum MAPISTATUS ocpf_clear_props | ( | uint32_t | context_id | ) |
Clear the known properties from the OCPF entity
context_id | identifier of the context to clear properties from |
References ocpf_context_search_by_context_id().
_PUBLIC_ int ocpf_del_context | ( | uint32_t | context_id | ) |
Delete an OCPF context
context_id | context identifier referencing the context to delete |
References ocpf_context_delete(), and ocpf_context_search_by_context_id().
_PUBLIC_ enum MAPISTATUS ocpf_get_recipients | ( | TALLOC_CTX * | mem_ctx, |
uint32_t | context_id, | ||
struct SRowSet ** | SRowSet | ||
) |
Get the message recipients from ocpf context
This function gets the recipient (To, Cc, Bcc) from the ocpf context and information stored.
mem_ctx | the memory context to use for memory allocation |
context_id | identifier to the context to set recipients for |
SRowSet | pointer on pointer to the set of recipients to return |
References ocpf_context_search_by_context_id().
_PUBLIC_ struct SPropValue* ocpf_get_SPropValue | ( | uint32_t | context_id, |
uint32_t * | cValues | ||
) | [read] |
Get the OCPF SPropValue array
This function is an accessor designed to return the SPropValue structure created with ocpf_set_SPropValue.
context_id | identifier of the context to retrieve SPropValue from |
cValues | pointer on the number of SPropValue entries |
References ocpf_context_search_by_context_id().
_PUBLIC_ int ocpf_init | ( | void | ) |
Initialize OCPF context
Initialize ocpf context and allocate memory for internal structures
_PUBLIC_ int ocpf_new_context | ( | const char * | filename, |
uint32_t * | context_id, | ||
uint8_t | flags | ||
) |
Create a new OCPF context
filename | the filename to process |
context_id | pointer to the context identifier the function |
flags | Flags controlling how the OCPF should be opened |
References ocpf_context_add().
_PUBLIC_ enum MAPISTATUS ocpf_OpenFolder | ( | uint32_t | context_id, |
mapi_object_t * | obj_store, | ||
mapi_object_t * | obj_folder | ||
) |
Open OCPF folder
This function opens the folder associated with the ocpf folder global context value.
context_id | identifier of the context to open the folder for |
obj_store | the store object |
obj_folder | the folder to open |
References ocpf_context_search_by_context_id().
_PUBLIC_ int ocpf_parse | ( | uint32_t | context_id | ) |
Parse OCPF file
Parse and process the given ocpf file.
context_id | the identifier of the context holding the file to be parsed |
References ocpf_context_search_by_context_id().
_PUBLIC_ int ocpf_release | ( | void | ) |
Uninitialize OCPF context
Uninitialize the global OCPF context and release memory.
_PUBLIC_ enum MAPISTATUS ocpf_set_Recipients | ( | TALLOC_CTX * | mem_ctx, |
uint32_t | context_id, | ||
mapi_object_t * | obj_message | ||
) |
Set the message recipients from ocpf context
This function sets the recipient (To, Cc, Bcc) from the ocpf context and information stored.
mem_ctx | the memory context to use for memory allocation |
context_id | identifier to the context to set recipients for |
obj_message | pointer to the message object we use for internal MAPI operations |
References ocpf_context_search_by_context_id().
_PUBLIC_ enum MAPISTATUS ocpf_set_SPropValue | ( | TALLOC_CTX * | mem_ctx, |
uint32_t | context_id, | ||
mapi_object_t * | obj_folder, | ||
mapi_object_t * | obj_message | ||
) |
Build a SPropValue array from ocpf context
This function builds a SPropValue array from the ocpf context and information stored.
mem_ctx | the memory context to use for memory allocation |
context_id | identifier of the context to build a SPropValue array for |
obj_folder | pointer the folder object we use for internal MAPI operations |
obj_message | pointer to the message object we use for internal MAPI operations |
References ocpf_context_search_by_context_id().
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |