include/serviceadapter/sa_syncml_binders.h

   1 /*
   2  * oma-dm-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef SA_BINDERS_H_
  19 #define SA_BINDERS_H_
  20
  21 /*dm-agent*/
  22 #include "common/dm_error.h"
  23 #include "serviceadapter/sa_define.h"
  24
  25 /**
  26  * @par Description: API to create syncml object binder
  27  *
  28  *
  29  * @par Purpose:
  30  * @par Typical use case:
  31  * @par Method of function operation:
  32  * @par Important notes:
  33  * @param[in]           Syncml structure
  34  * @param[out]          string type, msg
  35  * @param[out]          msg size
  36  *
  37  * @return                              DM_OK on success
  38  *                                                      DM_ERROR on fail
  39  *
  40  * @par Errors:
  41  *
  42  * @pre None.
  43  * @post
  44  * @see
  45  * @remarks None.
  46  *
  47  * @par Sample Code:
  48  * @code
  49  * @endcode
  50  */
  51 DM_ERROR syncml_objectbinder(SyncML * pSyncML, char **msg, unsigned int *msg_size);
  52
  53 /**
  54  * @par Description: API to reverse syncml object binder
  55  *
  56  *
  57  * @par Purpose:
  58  * @par Typical use case:
  59  * @par Method of function operation:
  60  * @par Important notes:
  61  * @param[out]          Syncml structure
  62  * @param[out]          string type, recieve msg
  63  * @param[out]          int type, recieve msg size
  64  * @param[out]          string type, xml
  65  * @param[out]          int type, xml  size
  66  *
  67  * @return                              DM_OK on success
  68  *                                                      DM_ERROR on fail
  69  *
  70  * @par Errors:
  71  *
  72  * @pre None.
  73  * @post
  74  * @see
  75  * @remarks None.
  76  *
  77  * @par Sample Code:
  78  * @code
  79  * @endcode
  80  */
  81 DM_ERROR reverse_syncml_objectbinder(SyncML ** pSyncML, char *recv_msg, unsigned int recv_msg_length, char **xml, unsigned int *xml_len);
  82
  83 #endif                          /* SA_BINDERS_H_ */