Utility API
[Category Manager API's]


Functions

alp_status_t alp_catmgr_dml_category_from_vCategory_buffer (AlpDmlH dmlH, const uint8_t *dataBuf, bool fromExgMgr, GList **categoryLuids)
alp_status_t alp_catmgr_dml_category_from_vCategory_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, GList **categoryLuids)
alp_status_t alp_catmgr_dml_category_to_vCategory_buffer (AlpDmlH dmlH, uint8_t **dataBuf, size_t *size, bool toExgMgr, GList *categoryLuids)
alp_status_t alp_catmgr_dml_category_to_vCategory_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, GList *categoryLuids)
alp_status_t alp_catmgr_dml_membership_from_vMembership_buffer (AlpDmlH dmlH, const uint8_t *dataBuf, bool fromExgMgr, GList **membershipLuids)
alp_status_t alp_catmgr_dml_membership_from_vMembership_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, GList **membershipLuids)
alp_status_t alp_catmgr_dml_membership_to_vMembership_buffer (AlpDmlH dmlH, uint8_t **dataBuf, size_t *size, bool toExgMgr, GList *membershipLuids)
alp_status_t alp_catmgr_dml_membership_to_vMembership_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, GList *membershipLuids)

Function Documentation

alp_status_t alp_catmgr_dml_category_from_vCategory_buffer (  AlpDmlH  dmlH,
const uint8_t *  dataBuf,
bool  fromExgMgr,
GList **  categoryLuids
) 
 

Creates one or more categories from the contents of a buffer containing vCategories.

If a given vCategory 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 categories for each vCategory.

Parameters:
[in] dmlH Handle to the catmgr data model.
[in] dataBuf NULL terminated buffer of vCategory(s).
[in] fromExgMgr true iff we are called to handle an exchange manager request
[in/out] categoryLuids If points to non-NULL value on input, and fromExgMgr is false, then it is assumed to be the AlpLuids of the vCategories to be modified. Otherwise the vCategories will be added and this will contain the list of new luids.
Returns:
alp_status_t

alp_status_t alp_catmgr_dml_category_from_vCategory_file (  AlpDmlH  dmlH,
int  theDataFd,
bool  fromExgMgr,
GList **  categoryLuids
) 
 

Creates one or more categories from the contents of a file containing vCategories.

If a given vCategory contains the GUID of an existing category, 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 categories for each vCategory.

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

alp_status_t alp_catmgr_dml_category_to_vCategory_buffer (  AlpDmlH  dmlH,
uint8_t **  dataBuf,
size_t *  size,
bool  toExgMgr,
GList *  categoryLuids
) 
 

Writes one or more category vCategories to an allocated buffer.

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

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

alp_status_t alp_catmgr_dml_category_to_vCategory_file (  AlpDmlH  dmlH,
int  theDataFd,
bool  toExgMgr,
GList *  categoryLuids
) 
 

Writes one or more category vCategories to the given file.

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

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

alp_status_t alp_catmgr_dml_membership_from_vMembership_buffer (  AlpDmlH  dmlH,
const uint8_t *  dataBuf,
bool  fromExgMgr,
GList **  membershipLuids
) 
 

Creates one or more categories from the contents of a buffer containing vMemberships.

If a given vMembership 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 categories for each vMembership.

Parameters:
[in] dmlH Handle to the catmgr data model.
[in] dataBuf NULL terminated buffer of vMembership(s).
[in] fromExgMgr true iff we are called to handle an exchange manager request
[in/out] membershipLuids If points to non-NULL value on input, and fromExgMgr is false, then it is assumed to be the AlpLuids of the vMemberships to be modified. Otherwise the vMemberships will be added and this will contain the list of new luids.
Returns:
alp_status_t

alp_status_t alp_catmgr_dml_membership_from_vMembership_file (  AlpDmlH  dmlH,
int  theDataFd,
bool  fromExgMgr,
GList **  membershipLuids
) 
 

Creates one or more category memberships from the contents of a file containing vMemberships.

If a given vMembership contains the GUID of an existing category membership, 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 category memberships for each vMembership.

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

alp_status_t alp_catmgr_dml_membership_to_vMembership_buffer (  AlpDmlH  dmlH,
uint8_t **  dataBuf,
size_t *  size,
bool  toExgMgr,
GList *  membershipLuids
) 
 

Writes one or more category memberships vMemberships to an allocated buffer.

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

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

alp_status_t alp_catmgr_dml_membership_to_vMembership_file (  AlpDmlH  dmlH,
int  theDataFd,
bool  toExgMgr,
GList *  membershipLuids
) 
 

Writes one or more category membership vMemberships to the given file.

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

Parameters:
[in] dmlH Handle to the catmgr data model.
[in] theDataFd The opened files descriptor of the file containing the vMembership(s). Must be opened and closed by the caller.
[in] toExgMgr true iff we are called to handle an exchange manager request
[in] membershipLuids List of AlpLuid's of all the categories 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.