libocpf/ocpf_write.c File Reference

public OCPF write API More...

#include "libocpf/ocpf_private.h"
#include <libocpf/ocpf.h>

Functions
_PUBLIC_ int	ocpf_write_auto (mapi_object_t *obj_message, struct mapi_SPropValue_array *mapi_lpProps)
_PUBLIC_ int	ocpf_write_commit (void)
_PUBLIC_ int	ocpf_write_init (const char *filename, mapi_id_t folder_id)
char *	ocpf_write_unescape_string (const char *value)

---

Detailed Description

public OCPF write API

---

Function Documentation

_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, OCPF_SUCCESS, and type.

_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.

char* ocpf_write_unescape_string

(

const char *

value

)

References ocpf.