octsdr-2g-wireshark/software/include/octvc1/octvc1_list.h

163 lines
5.3 KiB
C

/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
File: OCTVC1_LIST.h
Copyright (c) 2016 Octasic Inc. All rights reserved.
Description:
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program;if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Release: OCTSDR Software Development Kit OCTSDR_GSM-02.05.00-B780 (2016/01/14)
$Revision: $
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
#ifndef __OCTVC1_LIST_H__
#define __OCTVC1_LIST_H__
/***************************** INCLUDE FILES *******************************/
#include "../octdev_types.h"
#include "octvc1_base.h"
#include "octvc1_cursor.h"
/************************ COMMON DEFINITIONS *******************************/
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_HANDLE_OBJECT_GET
Handle Object list List structure,
Used when the objects to list are identified by a tOCTVC1_HANDLE_OBJECT.
Members:
ulNumHandleObject
Number of valid handle objects in aHandleObject
aHandleObject
Array containing the listed handles
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCT_UINT32 ulNumHandleObject;
tOCTVC1_HANDLE_OBJECT aHandleObject[cOCTVC1_HANDLE_OBJECT_LIST_MAX_ENTRY];
} tOCTVC1_LIST_HANDLE_OBJECT_GET;
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_NAME_OBJECT32_GET
Handle Object name List structure,
Used when the objects to list are identified by a tOCT_UINT32 and displayed by
name.
Members:
ulNumObject
Number of valid objects in aNamedObject
aNameObject32
Array containing the listed handles and named
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCT_UINT32 ulNumObject;
tOCTVC1_OBJECT32_NAME aNameObject32[cOCTVC1_HANDLE_OBJECT32_NAME_LIST_MAX_ENTRY];
} tOCTVC1_LIST_NAME_OBJECT32_GET;
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_HANDLE_OBJECT_GET_SUB_OBJECT_ID_NAME
Handle Object list List structure,
Used when the objects to list are identified by a tOCTVC1_SUB_OBJECT_ID.
Members:
hParent
Handle object of the parent
ulNumObject
Number of valid sub object IDs in aSubObjectId
aNameObject32
Array containing the listed handles
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_HANDLE_OBJECT hParent;
tOCT_UINT32 ulNumObject;
tOCTVC1_OBJECT32_NAME aNameObject32[cOCTVC1_HANDLE_OBJECT32_NAME_LIST_MAX_ENTRY];
} tOCTVC1_LIST_HANDLE_OBJECT_GET_SUB_OBJECT_ID_NAME;
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_HANDLE_OBJECT_GET_SUB_OBJECT_ID
Handle Object list List structure,
Used when the objects to list are identified by a tOCTVC1_SUB_OBJECT_ID.
Members:
hParent
Handle object of the parent
ulNumSubObjectId
Number of valid sub object IDs in aSubObjectId
aSubObjectId
Array containing the listed handles
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_HANDLE_OBJECT hParent;
tOCT_UINT32 ulNumSubObjectId;
tOCTVC1_SUB_OBJECT_ID aSubObjectId[cOCTVC1_HANDLE_OBJECT_LIST_MAX_ENTRY];
} tOCTVC1_LIST_HANDLE_OBJECT_GET_SUB_OBJECT_ID;
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_INDEX_GET
Object Index List structure,
Used when the objects to list are identified by a tOCTVC1_INDEX.
Members:
ulNumIndex
Number of valid index in aIndex
aIndex
Array containing the listed of indexes
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCT_UINT32 ulNumIndex;
tOCTVC1_INDEX aIndex[cOCTVC1_HANDLE_OBJECT_LIST_MAX_ENTRY];
} tOCTVC1_LIST_INDEX_GET;
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_INDEX_GET_SUB_INDEX
Object Index List structure,
Used when the objects to list are identified by a tOCTVC1_INDEX.
Members:
ulParentIndex
Index of the parent of the sub-index
ulNumIndex
Number of valid index in aIndex
aIndex
Array containing the listed of indexes
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_INDEX ulParentIndex;
tOCT_UINT32 ulNumIndex;
tOCTVC1_INDEX aIndex[cOCTVC1_HANDLE_OBJECT_LIST_MAX_ENTRY];
} tOCTVC1_LIST_INDEX_GET_SUB_INDEX;
#endif /* __OCTVC1_LIST_H__ */