uaPLUS Reference
GetItemHandles Method
See Also  Send Feedback
HDAPlugin Namespace > AppPlugin Class : GetItemHandles Method

itemID
An array of null terminated strings that uniquely identify the OPC HDA items.
clientHnd
The handle of the client to be associated with the item.
serverHnd
OUT: The returned handle of the server used to refer to this item.
errors
OUT: The status of association of the client to the server.

Glossary Item Box

Given a list of ItemIDs and client handles, this method returns the server handles for each item. The returned server handles must be used in all requests to read or update history. The supplied client handles are included in the returns of all read and update requests.

Syntax

Visual Basic (Declaration) 
Public Function GetItemHandles( _
   ByVal itemID() As String, _
   ByVal clientHnd() As Integer, _
   ByRef serverHnd As Integer(), _
   ByRef errors As Integer() _
) As Integer
C# 
public int GetItemHandles( 
   string[] itemID,
   int[] clientHnd,
   out int[] serverHnd,
   out int[] errors
)

Parameters

itemID
An array of null terminated strings that uniquely identify the OPC HDA items.
clientHnd
The handle of the client to be associated with the item.
serverHnd
OUT: The returned handle of the server used to refer to this item.
errors
OUT: The status of association of the client to the server.

Return Value

HRESULTS success/error code.

Remarks

The item is searched in the handle list or added if possible. The list index is returned as the server handle.

Requirements

Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

© 2010-2018 Copyright Advosol Inc. All Rights Reserved.