00001 /* 00002 * Copyright (c) 2010, FIP AUTHORS 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without 00006 * modification, are permitted provided that the following conditions are met: 00007 * 00008 * 1) Redistributions of source code must retain the above copyright notice, 00009 * this list of conditions and the following disclaimer. 00010 * 00011 * 2) Redistributions in binary form must reproduce the above copyright 00012 * notice, this list of conditions and the following disclaimer in the 00013 * documentation and/or other materials provided with the distribution. 00014 * 00015 * 3) Neither the name of the FIP AUTHORS nor the names of its contributors 00016 * may be used to endorse or promote products derived from this software 00017 * without specific prior written permission. 00018 * 00019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00021 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 00023 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00024 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00025 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00026 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00027 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00028 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00029 * POSSIBILITY OF SUCH DAMAGE. 00030 */ 00031 /** 00032 * @addtogroup fip_ds6 00033 * @{ 00034 */ 00035 /** 00036 * @file 00037 * Generic Data Structure Access Header 00038 * 00039 * @author 00040 * Colin O'Flynn 00041 */ 00042 00043 #ifndef FIP_DS6_H 00044 #define FIP_DS6_H 00045 00046 /* ################################## TYPES ############################### */ 00047 /** Index that points to a data structure entry. */ 00048 typedef unsigned char fip_ds6_index_t; 00049 00050 typedef enum { 00051 DS6_STATUS_NOTUSED = 0, 00052 } fip_ds6_enumStatus_t; 00053 00054 /** 00055 * Structure used to indicate the status of a search function. 00056 */ 00057 typedef struct { 00058 fip_bool_t itemFound; /**< Was item found or not? */ 00059 fip_ds6_index_t index; /**< If item was found, index to it */ 00060 } fip_ds6_searchStatus_t; 00061 00062 /* ################################## FUNCTIONS ########################### */ 00063 /* Note: Documented in associated .c file */ 00064 00065 fip_ds6_searchStatus_t fip_ds6_searchList(const unsigned char * ds, unsigned char entrySize, fip_ds6_index_t numberEntries, unsigned char offsetToItem, const unsigned char * searchTerm, unsigned char searchTermLength); 00066 00067 #endif // FIP_DS6_H 00068 00069 /** @} */
1.5.7.1