Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSDevices Interface Reference

List of all members.

Public Member Functions

HRESULT Add ([in] IDSSDevice *ipDevice)
 Add an item to the collection.
HRESULT Clear ()
 clear the collection
HRESULT Count ([out] Int32 *ipCount)
 Get the total number of items in the collection.
HRESULT get__NewEnum ([out, retval] IUnknown opp_NewEnum)
 Get the new enum.
HRESULT Item ([in] Int32 iIndex,[out, retval] IDSSDevice oppDevice)
 Get the item by index.
HRESULT ItemById ([in] BSTR *ipID,[out, retval] IDSSDevice oppDevice)
 Get the item by guid.
HRESULT RemoveByID ([in] BSTR *ipID)
 Remove an item from the collection by guid.
HRESULT RemoveByIndex ([in] Int32 iIndex)
 Remove an item from the collection by index.

Member Function Documentation

HRESULT IDSSDevices::Add [in] IDSSDevice ipDevice  ) 
 

Add an item to the collection.

Parameters:
ipDevice if this property is null, nothing will be added
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSDevices::Clear  ) 
 

clear the collection

Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSDevices::Count [out] Int32 *  ipCount  ) 
 

Get the total number of items in the collection.

Parameters:
ipCount Return the total number of items in collection This property should never be NULL
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSDevices::get__NewEnum [out, retval] IUnknown   opp_NewEnum  ) 
 

Get the new enum.

Parameters:
opp_NewEnum Return the new enum This property is never NULL.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSDevices::Item [in] Int32  iIndex,
[out, retval] IDSSDevice   oppDevice
 

Get the item by index.

Parameters:
iIndex The Index of the device in the collection.
oppDevice Return the item by the given index in collection This property could be NULL if the index is not found
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSDevices::ItemById [in] BSTR *  ipID,
[out, retval] IDSSDevice   oppDevice
 

Get the item by guid.

Parameters:
ipID The ID of the Device.
oppDevice Return the item by the given guid in collection This property could be NULL if the guid is not found
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSDevices::RemoveByID [in] BSTR *  ipID  ) 
 

Remove an item from the collection by guid.

Parameters:
ipID if this property is null, nothing will be removed
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSDevices::RemoveByIndex [in] Int32  iIndex  ) 
 

Remove an item from the collection by index.

Parameters:
iIndex 
Returns:
Usual COM result code:
  • S_OK Operation succeeded.


Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.