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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
use crate::opc_da::{
client::ItemAttributeIterator,
com_utils::RemoteArray,
errors::{OpcError, OpcResult},
typedefs::ItemHandle,
};
use windows::core::Interface as _;
/// Item management functionality.
///
/// Provides methods to manage OPC items within a group, including adding,
/// removing, and modifying item properties such as active state, client
/// handles, and data types.
pub trait ItemMgtTrait {
fn interface(&self) -> OpcResult<&crate::bindings::da::IOPCItemMgt>;
/// Adds items to the group.
///
/// # Arguments
/// * `items` - Array of item definitions containing item IDs and requested properties
///
/// # Returns
/// Tuple containing:
/// - Array of item results with server handles and canonical data type
/// - Array of per-item error codes
///
/// # Errors
/// Returns E_INVALIDARG if items array is empty
fn add_items(
&self,
items: &[crate::bindings::da::tagOPCITEMDEF],
) -> OpcResult<(
RemoteArray<crate::bindings::da::tagOPCITEMRESULT>,
RemoteArray<windows::core::HRESULT>,
)> {
if items.is_empty() {
return Err(OpcError::InvalidState("items cannot be empty".to_string()));
}
let len = items.len().try_into()?;
tracing::debug!(
item_count = len,
"Adding items to OPC group natively via IOPCItemMgt"
);
let mut results = RemoteArray::new(len);
let mut errors = RemoteArray::new(len);
// SAFETY: Calling COM interface method AddItems with valid item definition pointers and output arrays.
unsafe {
self.interface()?.AddItems(
len,
items.as_ptr(),
results.as_mut_ptr(),
errors.as_mut_ptr(),
)?;
}
Ok((results, errors))
}
/// Validates item definitions without adding them to the group.
///
/// # Arguments
/// * `items` - Array of item definitions to validate
/// * `blob_update` - Whether to validate blob update capability
///
/// # Returns
/// Tuple containing:
/// - Array of item results with access rights and canonical data type
/// - Array of per-item error codes
fn validate_items(
&self,
items: &[crate::bindings::da::tagOPCITEMDEF],
blob_update: bool,
) -> OpcResult<(
RemoteArray<crate::bindings::da::tagOPCITEMRESULT>,
RemoteArray<windows::core::HRESULT>,
)> {
if items.is_empty() {
return Err(OpcError::InvalidState("items cannot be empty".to_string()));
}
let len = items.len().try_into()?;
let mut results = RemoteArray::new(len);
let mut errors = RemoteArray::new(len);
// SAFETY: Calling COM interface method ValidateItems with valid item definition pointers and output arrays.
unsafe {
self.interface()?.ValidateItems(
len,
items.as_ptr(),
blob_update,
results.as_mut_ptr(),
errors.as_mut_ptr(),
)?;
}
Ok((results, errors))
}
/// Removes items from the group.
///
/// # Arguments
/// * `server_handles` - Array of server handles for items to remove
///
/// # Returns
/// Array of per-item error codes
///
/// # Errors
/// Returns E_INVALIDARG if server_handles is empty
fn remove_items(
&self,
server_handles: &[ItemHandle],
) -> OpcResult<RemoteArray<windows::core::HRESULT>> {
if server_handles.is_empty() {
return Err(OpcError::InvalidState(
"server_handles cannot be empty".to_string(),
));
}
let len = server_handles.len().try_into()?;
tracing::debug!(
item_count = len,
"Removing items from OPC group natively via IOPCItemMgt"
);
let mut errors = RemoteArray::new(len);
// SAFETY: Calling COM interface method RemoveItems with valid server handles pointer.
unsafe {
self.interface()?.RemoveItems(
len,
server_handles.as_ptr() as *const u32,
errors.as_mut_ptr(),
)?;
}
Ok(errors)
}
/// Sets the active state of items.
///
/// # Arguments
/// * `server_handles` - Array of server handles
/// * `active` - True to activate items, false to deactivate
///
/// # Returns
/// Array of per-item error codes
///
/// # Errors
/// Returns E_INVALIDARG if server_handles is empty
fn set_active_state(
&self,
server_handles: &[ItemHandle],
active: bool,
) -> OpcResult<RemoteArray<windows::core::HRESULT>> {
if server_handles.is_empty() {
return Err(OpcError::InvalidState(
"server_handles cannot be empty".to_string(),
));
}
let len = server_handles.len().try_into()?;
let mut errors = RemoteArray::new(len);
// SAFETY: Calling COM interface method SetActiveState with valid server handles pointer.
unsafe {
self.interface()?.SetActiveState(
len,
server_handles.as_ptr() as *const u32,
active,
errors.as_mut_ptr(),
)?;
}
Ok(errors)
}
/// Sets client handles for items.
///
/// # Arguments
/// * `server_handles` - Array of server handles
/// * `client_handles` - Array of new client handles
///
/// # Returns
/// Array of per-item error codes
///
/// # Errors
/// Returns E_INVALIDARG if arrays are empty or have different lengths
fn set_client_handles(
&self,
server_handles: &[ItemHandle],
client_handles: &[ItemHandle],
) -> OpcResult<RemoteArray<windows::core::HRESULT>> {
if server_handles.len() != client_handles.len() {
return Err(OpcError::InvalidState(
"server_handles and client_handles must have the same length".to_string(),
));
}
if server_handles.is_empty() {
return Err(OpcError::InvalidState(
"server_handles cannot be empty".to_string(),
));
}
let len = server_handles.len().try_into()?;
let mut errors = RemoteArray::new(len);
// SAFETY: Calling COM interface method SetClientHandles with valid handle pointers.
unsafe {
self.interface()?.SetClientHandles(
len,
server_handles.as_ptr() as *const u32,
client_handles.as_ptr() as *const u32,
errors.as_mut_ptr(),
)?;
}
Ok(errors)
}
/// Sets requested data types for items.
///
/// # Arguments
/// * `server_handles` - Array of server handles
/// * `requested_datatypes` - Array of VT_* data types
///
/// # Returns
/// Array of per-item error codes
///
/// # Errors
/// Returns E_INVALIDARG if arrays are empty or have different lengths
fn set_datatypes(
&self,
server_handles: &[ItemHandle],
requested_datatypes: &[u16],
) -> OpcResult<RemoteArray<windows::core::HRESULT>> {
if server_handles.len() != requested_datatypes.len() {
return Err(OpcError::InvalidState(
"server_handles and requested_datatypes must have the same length".to_string(),
));
}
if server_handles.is_empty() {
return Err(OpcError::InvalidState(
"server_handles cannot be empty".to_string(),
));
}
let len = server_handles.len().try_into()?;
let mut errors = RemoteArray::new(len);
// SAFETY: Calling COM interface method SetDatatypes with valid datatype array pointer.
unsafe {
self.interface()?.SetDatatypes(
len,
server_handles.as_ptr() as *const u32,
requested_datatypes.as_ptr(),
errors.as_mut_ptr(),
)?;
}
Ok(errors)
}
/// Creates an enumerator for item management.
///
/// # Arguments
/// * `id` - Interface ID specifying the type of enumerator
///
/// # Returns
/// Enumerator interface for iterating through items
fn create_enumerator(&self) -> OpcResult<ItemAttributeIterator> {
// SAFETY: Calling COM interface method CreateEnumerator.
let enumerator = unsafe {
self.interface()?.CreateEnumerator(
&<crate::bindings::da::IEnumOPCItemAttributes as windows_core::Interface>::IID,
)?
};
Ok(ItemAttributeIterator::new(enumerator.cast()?))
}
}
// ...existing code...