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

IDSSAttributes2 Interface Reference

Inherits IDSSAttributes.

List of all members.


Detailed Description

IDSSAttributes2 extends IDSSAttributes by adding some other functionality.


Public Member Functions

HRESULT AddID ([in] BSTR iID,[in, defaultvalue(0)] Int32 Index)
 Access members of the collection.
HRESULT Exist ([in] BSTR iID,[out, retval] VARIANT_BOOL *opExist)
 Check whether the ID exists in the collection.
HRESULT ItemID ([in] Int32 iIndex,[out, retval] BSTR *opID)
 Access members of the collection.


Member Function Documentation

HRESULT IDSSAttributes2::AddID [in] BSTR  iID,
[in, defaultvalue(0)] Int32  Index
 

Access members of the collection.

Add an attribute id into the collection.

The contents of the collection are numbered from 1 to Count.
Parameters:
iID The attribute id we are going to insert.
Index The position this id will be inserted at.
Returns:
Usual COM result code:
  • S_OK
  • E_INVALIDARG The caller passes in an invalid attribute ID.

HRESULT IDSSAttributes2::Exist [in] BSTR  iID,
[out, retval] VARIANT_BOOL *  opExist
 

Check whether the ID exists in the collection.

In current implementation, it runs in logN. Due to current implementation limitation, inserting duplicate entries to the IDSSAttributes2 collection is rather slow(linear time), So please check whether the attribute is already there before inserting.

Parameters:
iID the ID of the attribute
opExist the result, indicating whether the attribute with specified ID eixsts
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSAttributes2::ItemID [in] Int32  iIndex,
[out, retval] BSTR *  opID
 

Access members of the collection.

Return a attribute id from the collection. The index parameter must be a number.

The contents of the collection are numbered from 1 to Count.
Parameters:
iIndex 1-based index of the desired attribute in the collection.
opID String ID of the desired attribute in the collection.
Returns:
Usual COM result code:
  • S_OK
  • E_INVALIDARG The caller passes in an invalid attribute ID.


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