include/ServiceAdapter/SA_DevInf.h

   1 /*
   2  * oma-ds-service
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: JuHak Park <juhaki.park@samsung.com>,
   7  *          JuneHyuk Lee <junhyuk7.lee@samsung.com>,
   8  *          SunBong Ha <sunbong.ha@samsung.com>
   9  *
  10  * Licensed under the Apache License, Version 2.0 (the "License");
  11  * you may not use this file except in compliance with the License.
  12  * You may obtain a copy of the License at
  13  *
  14  * http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  *
  22  */
  23
  24
  25
  26
  27
  28 /*
  29  * For any sort of issue you concern as to this software,
  30  * you may use following point of contact.
  31  * All resources contributed on this software
  32  * are orinigally written by S-Core Inc., a member of Samsung Group.
  33  *
  34  * SeongWon Shim <seongwon.shim@samsung.com>
  35  */
  36
  37 /**
  38  *   @SA_DevInf.h
  39  *   @version                                                                   0.1
  40  *   @brief                                                                             This file is the header file of interface of DevInf structure
  41  */
  42
  43 #ifndef SA_DEVINF_H_
  44 #define SA_DEVINF_H_
  45
  46 #include "ServiceAdapter/SA_Define.h"
  47
  48 /**
  49  * @par Description: API to create DevInf structure
  50  *
  51  * @par Purpose:
  52  * @par Typical use case:
  53  * @par Method of function operation:
  54  * @par Important notes:
  55  * @param[in]           Session structure
  56  * @param[out]          DevInf  structure
  57  *
  58  * @return                      ERROR_INTERNAL_OK on success
  59  *                                              ERROR_INTERNAL_ERROR, ERROR_INTERNAL_NOT_DEFINED, ERROR_INTERNAL_NO_MEMORY on error
  60  *
  61  * @par Errors:
  62  *
  63  * @pre None.
  64  * @post
  65  * @see
  66  * @remarks None.
  67  *
  68  * @par Sample Code:
  69  * @code
  70  * @endcode
  71  */
  72 SA_ErrorType create_devinf(Session *session, DevInf **pDevInf);
  73
  74 /**
  75  * @par Description: API to free DevInf structure
  76  *
  77  * @par Purpose:
  78  * @par Typical use case:
  79  * @par Method of function operation:
  80  * @par Important notes:
  81  * @param[in]           DevInf  structure
  82  *
  83  * @return
  84  *
  85  * @par Errors:
  86  *
  87  * @pre None.
  88  * @post
  89  * @see
  90  * @remarks None.
  91  *
  92  * @par Sample Code:
  93  * @code
  94  * @endcode
  95  */
  96 void free_devinf(DevInf *devInf);
  97
  98 /**
  99  * @par Description: API to set sync cap in DevInfDataStore structure
 100  *
 101  * @par Purpose:
 102  * @par Typical use case:
 103  * @par Method of function operation:
 104  * @par Important notes:
 105  * @param[in]           DevInfDataStore structure
 106  * @param[in]           DevInf sync type
 107  * @param[in]           whether support or not
 108  *
 109  * @return
 110  *
 111  * @par Errors:
 112  *
 113  * @pre None.
 114  * @post
 115  * @see
 116  * @remarks None.
 117  *
 118  * @par Sample Code:
 119  * @code
 120  * @endcode
 121  */
 122 void set_devInf_datastore_synccap(DevInfDataStore *devInfDataStore, DevInfSyncCap cap, int supported);
 123
 124
 125 /**
 126  * @par Description: API to get sync cap from DevInfDataStore structure
 127  *
 128  * @par Purpose:
 129  * @par Typical use case:
 130  * @par Method of function operation:
 131  * @par Important notes:
 132  * @param[in]           DevInfDataStore structure
 133  * @param[in]           DevInf sync type
 134  *
 135  * @return                              True on success
 136  *                                                      False on error
 137  *
 138  * @par Errors:
 139  *
 140  * @pre None.
 141  * @post
 142  * @see
 143  * @remarks None.
 144  *
 145  * @par Sample Code:
 146  * @code
 147  * @endcode
 148  */
 149 int get_devinf_datastore_synccap(const DevInfDataStore *devInfDataStore, DevInfSyncCap cap);
 150
 151 /*
 152 DevInfSyncCap convert_devinf_synccap(unsigned int id);
 153 */
 154 #endif /* SA_DEVINF_H_ */