XDASrv Reference Manual
QueryProperties Method
See Also  Send Feedback
NSPlugin Namespace > GenericServer Class : QueryProperties Method




ItemHandle
Application item handle
numProp
Number of properties retruned
IDs
Array with the the property ID number
Names
Array with the property names. This symbolic name is used only in the XML-DA server. It is ignored by the DANSrv OPC DA server.
Descriptions
Array with the property description
Values
Array with the current property values
Query the properties defined for the specified item

Syntax

Visual Basic (Declaration) 
Public Function QueryProperties( _
   ByVal ItemHandle As Integer, _
   ByRef numProp As Integer, _
   ByRef IDs As Integer(), _
   ByRef Names As String(), _
   ByRef Descriptions As String(), _
   ByRef Values As Object() _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As GenericServer
Dim ItemHandle As Integer
Dim numProp As Integer
Dim IDs As Integer()
Dim Names As String()
Dim Descriptions As String()
Dim Values As Object()
Dim value As Integer
 
value = instance.QueryProperties(ItemHandle, numProp, IDs, Names, Descriptions, Values)
C# 
public int QueryProperties( 
   int ItemHandle,
   out int numProp,
   out int[] IDs,
   out string[] Names,
   out string[] Descriptions,
   out object[] Values
)
Managed Extensions for C++ 
public: int QueryProperties( 
   int ItemHandle,
   [PARAMFLAG::Out] int numProp,
   [PARAMFLAG::Out] int[] IDs,
   [PARAMFLAG::Out] string*[] Names,
   [PARAMFLAG::Out] string*[] Descriptions,
   [PARAMFLAG::Out] Object*[] Values
) 
C++/CLI 
public:
int QueryProperties( 
   int ItemHandle,
   [Out] int numProp,
   [Out] array<int> IDs,
   [Out] array<String^> Names,
   [Out] array<String^> Descriptions,
   [Out] array<Object^> Values
) 

Parameters

ItemHandle
Application item handle
numProp
Number of properties retruned
IDs
Array with the the property ID number
Names
Array with the property names. This symbolic name is used only in the XML-DA server. It is ignored by the DANSrv OPC DA server.
Descriptions
Array with the property description
Values
Array with the current property values

Return Value

HRESULT success/error code. S_FALSE if the item has no custom properties.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

Copyright © 2002-2011 Advosol Inc. All Rights Reserved.