libocpf/proto.h File Reference

Defines

#define __BEGIN_DECLS
#define __END_DECLS
#define _PRINTF_ATTRIBUTE(a1, a2)
#define _PRINTF_ATTRIBUTE(a1, a2)   PRINTF_ATTRIBUTE(a1, a2)

Functions

_PUBLIC_ void ocpf_dump (void)
void ocpf_dump_folder (void)
_PUBLIC_ void ocpf_dump_named_property (void)
void ocpf_dump_oleguid (void)
_PUBLIC_ void ocpf_dump_property (void)
void ocpf_dump_recipients (void)
void ocpf_dump_type (void)
void ocpf_dump_variable (void)
struct SPropValue * ocpf_get_SPropValue (uint32_t *)
__BEGIN_DECLS int ocpf_init (void)
enum MAPISTATUS ocpf_OpenFolder (mapi_object_t *, mapi_object_t *)
int ocpf_parse (const char *)
int ocpf_release (void)
enum MAPISTATUS ocpf_set_Recipients (TALLOC_CTX *, mapi_object_t *)
enum MAPISTATUS ocpf_set_SPropValue (TALLOC_CTX *, mapi_object_t *obj_folder, mapi_object_t *)
_PUBLIC_ int ocpf_write_auto (mapi_object_t *, struct mapi_SPropValue_array *)
_PUBLIC_ int ocpf_write_commit (void)
_PUBLIC_ int ocpf_write_init (const char *, mapi_id_t)

Define Documentation

#define __BEGIN_DECLS
#define __END_DECLS
#define _PRINTF_ATTRIBUTE ( a1,
a2   ) 
#define _PRINTF_ATTRIBUTE ( a1,
a2   )     PRINTF_ATTRIBUTE(a1, a2)

Function Documentation

void ocpf_dump_folder ( void   ) 

Dump OCPF Destination Folder

Dump OCPF Registered Destination Folder

References INDENT, indent, ocpf, OCPF_DUMP, OCPF_DUMP_TITLE, and OCPF_DUMP_TOPLEVEL.

Referenced by ocpf_dump().

_PUBLIC_ void ocpf_dump_named_property ( void   ) 
void ocpf_dump_oleguid ( void   ) 

Dump OCPF OLEGUID

Dump OCPF Registered OLEGUID

References INDENT, indent, ocpf, OCPF_DUMP_TITLE, and OCPF_DUMP_TOPLEVEL.

Referenced by ocpf_dump().

_PUBLIC_ void ocpf_dump_property ( void   ) 

References INDENT, indent, ocpf, OCPF_DUMP_TITLE, and OCPF_DUMP_TOPLEVEL.

Referenced by ocpf_dump().

void ocpf_dump_recipients ( void   ) 

Dump OCPF Recipients

Dump OCPF Recipients

References INDENT, indent, ocpf, OCPF_DUMP_TITLE, and OCPF_DUMP_TOPLEVEL.

Referenced by ocpf_dump().

void ocpf_dump_type ( void   ) 

Dump OCPF Type

Dump OCPF Registered Type

References INDENT, indent, ocpf, OCPF_DUMP, OCPF_DUMP_TITLE, and OCPF_DUMP_TOPLEVEL.

Referenced by ocpf_dump().

void ocpf_dump_variable ( void   ) 

References INDENT, indent, ocpf, OCPF_DUMP_TITLE, and OCPF_DUMP_TOPLEVEL.

Referenced by ocpf_dump().

struct SPropValue* ocpf_get_SPropValue ( 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.

Parameters:
cValues pointer on the number of SPropValue entries
Returns:
NULL on error, otherwise returns an allocated lpProps pointer
See also:
ocpf_set_SPropValue

References ocpf.

__BEGIN_DECLS int ocpf_init ( void   ) 

Initialize OCPF context

Initialize ocpf context and allocate memory for internal structures

Returns:
OCPF_SUCCESS on success, otherwise OCPF_ERROR
See also:
ocpf_release, ocpf_parse

References ocpf, OCPF_ERROR, and OCPF_SUCCESS.

enum MAPISTATUS ocpf_OpenFolder ( 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.

Parameters:
obj_store the store object
obj_folder the folder to open
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_FOUND.
Note:
Developers should call GetLastError() to retrieve the last MAPI error code. Possible MAPI error codes are:
  • MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized.
  • MAPI_E_INVALID_PARAMETER: obj_store is undefined
  • MAPI_E_NOT_FOUND: The specified folder could not be found or is not yet supported.
See also:
ocpf_init, ocpf_parse

References ocpf.

int ocpf_parse ( const char *  filename  ) 

Parse OCPF file

Parse and process the given ocpf file.

Parameters:
filename the file to parse
Returns:
OCPF_SUCCESS on success, otherwise OCPF_ERROR
See also:
ocpf_init

References lineno, ocpf, OCPF_ERROR, ocpf_yyparse(), and yyin.

int ocpf_release ( void   ) 

Uninitialize OCPF context

Uninitialize the global OCPF context and release memory.

Returns:
OCPF_SUCCESS on success, otherwise OCPF_ERROR
See also:
ocpf_init

References ocpf, OCPF_ERROR, and OCPF_SUCCESS.

enum MAPISTATUS ocpf_set_Recipients ( TALLOC_CTX *  mem_ctx,
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.

Parameters:
mem_ctx the memory context to use for memory allocation
obj_message pointer to the message object we use for internal MAPI operations
Returns:
OCPF_SUCCESS on success, otherwise OCPF_ERROR.
See also:
ocpf

References ocpf.

enum MAPISTATUS ocpf_set_SPropValue ( TALLOC_CTX *  mem_ctx,
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.

Parameters:
mem_ctx the memory context to use for memory allocation
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
Returns:
MAPI_E_SUCCESS on success, otherwise -1.
Note:
Developers should call GetLastError() to retrieve the last MAPI error code. Possible MAPI error codes are:
  • MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
See also:
ocpf_get_SPropValue

References MAX_READ_SIZE, and ocpf.

_PUBLIC_ int ocpf_write_auto ( mapi_object_t *  obj_message,
struct mapi_SPropValue_array *  mapi_lpProps 
)

Create the OCPF structure required for the commit operation

This function process properties and named properties from the specified mapi_SPropValue_array and generates an OCPF structure with all the attributes required to create an OCPF file in the commit operation.

Parameters:
obj_message the message object
mapi_lpProps the array of mapi properties returned by GetPropsAll
Returns:
OCPF_SUCCESS on success, otherwise OCPF_ERROR
See also:
GetPropsAll, ocpf_write_commit

References ocpf, and OCPF_SUCCESS.

_PUBLIC_ int ocpf_write_commit ( void   ) 

Write OCPF structure to OCPF file

This function dumps the OCPF structure content into the OCPF file defined in ocpf_write_init.

Returns:
OCPF_SUCCESS on success, otherwise OCPF_ERROR
See also:
ocpf_write_init, ocpf_write_auto

References ocpf, and OCPF_SUCCESS.

_PUBLIC_ int ocpf_write_init ( const char *  filename,
mapi_id_t  folder_id 
)

Specify the OCPF file name to write

Specify the ocpf file to create

Parameters:
filename output filename
folder_id the folder
Returns:
OCPF_SUCCESS on success, otherwise OCPF_ERROR
See also:
ocpf_init

References ocpf, and OCPF_SUCCESS.


Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/