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




itemID
The fully qualified item ID.
returnValues
The property value must be returned additionally.
returnAll
All properties defined for this item have to be returned. The numProp and propertyIDs arguments are undefined in this case.
numProp
The number of requested properties. Ignore this argument if returnAll is true.
propertyIDs
REF: Array with the IDs of the properties to be returned. If returnAll is true then this argument should be ignored and used as an out parameter to return an array with the IDs of the returned properties.
propertyNames
OUT: Array with the name of each returned property. This is used only in the XML DA server.
propertyDescr
OUT: Array with the description of each returned property.
Values
OUT: Array with the Value of each returned property. Only if returnValues is true. Otherwise null is returned.
errors
OUT: Array with the HRESULT code of each returned property.

Virtual mode browse handling.

Called only from the Professional edition generic server.

Returns the the values of the requested properties for one item. This method is called in virtual browse mode for items that are not yet added to the generic cache.

Syntax

Visual Basic (Declaration) 
Public Function GetItemProperties( _
   ByVal itemID As String, _
   ByVal returnValues As Boolean, _
   ByVal returnAll As Boolean, _
   ByRef numProp As Integer, _
   ByRef propertyIDs As Integer(), _
   ByRef propertyNames As String(), _
   ByRef propertyDescr As String(), _
   ByRef Values As Object(), _
   ByRef errors As Integer() _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As GenericServer
Dim itemID As String
Dim returnValues As Boolean
Dim returnAll As Boolean
Dim numProp As Integer
Dim propertyIDs As Integer()
Dim propertyNames As String()
Dim propertyDescr As String()
Dim Values As Object()
Dim errors As Integer()
Dim value As Integer
 
value = instance.GetItemProperties(itemID, returnValues, returnAll, numProp, propertyIDs, propertyNames, propertyDescr, Values, errors)
C# 
public int GetItemProperties( 
   string itemID,
   bool returnValues,
   bool returnAll,
   ref int numProp,
   ref int[] propertyIDs,
   out string[] propertyNames,
   out string[] propertyDescr,
   out object[] Values,
   out int[] errors
)
Managed Extensions for C++ 
public: int GetItemProperties( 
   string* itemID,
   bool returnValues,
   bool returnAll,
   ref int numProp,
   ref int[] propertyIDs,
   [PARAMFLAG::Out] string*[] propertyNames,
   [PARAMFLAG::Out] string*[] propertyDescr,
   [PARAMFLAG::Out] Object*[] Values,
   [PARAMFLAG::Out] int[] errors
) 
C++/CLI 
public:
int GetItemProperties( 
   String^ itemID,
   bool returnValues,
   bool returnAll,
   int% numProp,
   array<int>% propertyIDs,
   [Out] array<String^> propertyNames,
   [Out] array<String^> propertyDescr,
   [Out] array<Object^> Values,
   [Out] array<int> errors
) 

Parameters

itemID
The fully qualified item ID.
returnValues
The property value must be returned additionally.
returnAll
All properties defined for this item have to be returned. The numProp and propertyIDs arguments are undefined in this case.
numProp
The number of requested properties. Ignore this argument if returnAll is true.
propertyIDs
REF: Array with the IDs of the properties to be returned. If returnAll is true then this argument should be ignored and used as an out parameter to return an array with the IDs of the returned properties.
propertyNames
OUT: Array with the name of each returned property. This is used only in the XML DA server.
propertyDescr
OUT: Array with the description of each returned property.
Values
OUT: Array with the Value of each returned property. Only if returnValues is true. Otherwise null is returned.
errors
OUT: Array with the HRESULT code of each returned property.

Return Value

HRESULT success/error code. Returns S_OK if all requested properties are successfully returned, S_FALSE if an error is returned for one or more properties. If an error is returned then the out parameters are null (Nothing) HRESULT error/success code

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.