blob: b423224de01648dde2d0621fecd46ededbada059 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
File: OCTVC1_LIST.h
Copyright (c) 2018 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 Affero General Public License as published by
the Free Software Foundation; either version 3 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 Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Release: OCTSDR Software Development Kit OCTSDR_GSM-02.10.00-B1837 (2018/02/21)
$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;
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_NAME128_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
aName128Object32
Array containing the listed handles and named
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCT_UINT32 ulNumObject;
tOCTVC1_OBJECT32_NAME128 aName128Object32[cOCTVC1_HANDLE_OBJECT32_NAME128_LIST_MAX_ENTRY];
} tOCTVC1_LIST_NAME128_OBJECT32_GET;
/*-------------------------------------------------------------------------------------
tOCTVC1_LIST_HANDLE_OBJECT_GET_SUB_OBJECT_ID_NAME128
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
aName128Object32
Array containing the listed handles
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_HANDLE_OBJECT hParent;
tOCT_UINT32 ulNumObject;
tOCTVC1_OBJECT32_NAME128 aName128Object32[cOCTVC1_HANDLE_OBJECT32_NAME128_LIST_MAX_ENTRY];
} tOCTVC1_LIST_HANDLE_OBJECT_GET_SUB_OBJECT_ID_NAME128;
#endif /* __OCTVC1_LIST_H__ */
|
