Memo Utility API
[Data Model API's]

Detailed Description

Deprecated. Use alp_memo_dml_remove_memberships instead.


Functions

AlpDmlH alp_memo_dml_get_catmgr_handle (AlpDmlH dmlH)
alp_status_t alp_memo_dml_read_from_vNote_buffer (AlpDmlH dmlH, const uint8_t *dataBuf, uint32_t size, bool fromExgMgr, bool forModify, GList **memoLuids)
 Deprecated. Use alp_memo_dml_read_from_vNote_file instead.
alp_status_t alp_memo_dml_read_from_vNote_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, bool forModify, GList **memoLuids)
alp_status_t alp_memo_dml_write_to_vNote_buffer (AlpDmlH dmlH, uint8_t **dataBuf, uint32_t *size, bool toExgMgr, const GList *memoLuids)
 Deprecated. Use alp_memo_dml_write_to_vNote_file instead.
alp_status_t alp_memo_dml_write_to_vNote_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, const GList *memoLuids)
 Deprecated. Use alp_memo_dml_read_from_vNote_buffer instead.

Function Documentation

AlpDmlH alp_memo_dml_get_catmgr_handle (  AlpDmlH  dmlH  ) 
 

Retrieves a handle to the catmgr from the actual given dml handle. The returned handle should be used to make calls to the catui.

Parameters:
[in] dmlH AlpDmlH handle to memo data model to execute against.
Returns:
AlpDmlH

alp_status_t alp_memo_dml_read_from_vNote_buffer (  AlpDmlH  dmlH,
const uint8_t *  dataBuf,
uint32_t  size,
bool  fromExgMgr,
bool  forModify,
GList **  memoLuids
) 
 

Deprecated. Use alp_memo_dml_read_from_vNote_file instead.

Creates one or more memos from the contents of a buffer containing vNotes.

If a given vNote contains the GUID of an existing person, and we are called to handle an exchange manager request, than that data will replace what is already in the database. Otherwise this function creates new memos for each vNote.

Parameters:
[in] dmlH Handle to the memo data model.
[in] dataBuf NULL terminated buffer of vNote(s).
[in] dataBufSize Number of bytes in dataBuf, -1 if NULL terminated.
[in] fromExgMgr true iff we are called to handle an exchange manager request
[in] forModify true iff we are called to modify existing data items.
[in/out] memoLuids If points to non-NULL value on input, and fromExgMgr is false, then it is assumed to be the AlpLuids of the vNotes to be modified. Otherwise the vNotes will be added and this will contain the list of new luids.
Returns:
alp_status_t

alp_status_t alp_memo_dml_read_from_vNote_file (  AlpDmlH  dmlH,
int  theDataFd,
bool  fromExgMgr,
bool  forModify,
GList **  memoLuids
) 
 

Creates one or more memos from the contents of a file containing vNotes.

If a given vNote contains the GUID of an existing memo, and we are called to handle an exchange manager request, than that data will replace what is already in the database. Otherwise this function creates new memos for each vNote.

Parameters:
[in] dmlH Handle to the memo data model.
[in] theDataFd The opened files descriptor of the file containing the vNote(s). Must be opened and closed by the caller.
[in] fromExgMgr true iff we are called to handle an exchange manager request
[in] forModify true iff we are called to modify existing data items.
[in/out] memoLuids If points to non-NULL value on input, and fromExgMgr is false, then it is assumed to be the AlpLuids of the vNotes to be modified. Otherwise the vNotes will be added and this will contain the list of new luids.
Returns:
alp_status_t

alp_status_t alp_memo_dml_write_to_vNote_buffer (  AlpDmlH  dmlH,
uint8_t **  dataBuf,
uint32_t *  size,
bool  toExgMgr,
const GList *  memoLuids
) 
 

Deprecated. Use alp_memo_dml_write_to_vNote_file instead.

Writes one or more memo vNotes to an allocated buffer.

If called to handle an exchange manager request we'll add the GUID to the vNote.

Parameters:
[in] dmlH Handle to the memo data model.
[out] dataBuf Allocated buffer of vNote(s). NULL terminated. Must be free'd by the caller.
[out] size size of buffer in dataBuf param
[in] toExgMgr true iff we are called to handle an exchange manager request
[in] memoLuids List of AlpLuid's of all the memos to write.
Returns:
alp_status_t

alp_status_t alp_memo_dml_write_to_vNote_file (  AlpDmlH  dmlH,
int  theDataFd,
bool  toExgMgr,
const GList *  memoLuids
) 
 

Deprecated. Use alp_memo_dml_read_from_vNote_buffer instead.

Writes one or more memo vNotes to the given file.

If called to handle an exchange manager request we'll add the GUID to the vNote.

Parameters:
[in] dmlH Handle to the memo data model.
[in] theDataFd The opened files descriptor of the file containing the vNote(s). Must be opened and closed by the caller.
[in] toExgMgr true iff we are called to handle an exchange manager request
[in] memoLuids List of AlpLuid's of all the memos to write.
Returns:
alp_status_t

Generated on Wed Jul 30 07:06:41 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.