IDSSAttributeInfos Interface Reference

List of all members.

---

Detailed Description

The IDSSAttributeInfos interface implements a collection of IDSSAttributeInfo objects.

The collection is implemented on a table object to record the set of attributes, and their forms that are available on the table. If necessary, the AttributeInfo objects can include an AttributeDefn object to override the default definition of some or all of the attribute forms.

Public Member Functions
HRESULT	_NewEnum ([out, retval] IUnknown pp_NewEnum)
	Enumerator for this collection.
HRESULT	Add ([in] IDSSAttribute *pAttribute,[out, retval] IDSSAttributeInfo ppAttributeInfo)
	Insert a new AttributeInfo into the collection.
HRESULT	Clear ()
	Empty the collection.
HRESULT	Count ([out, retval] Int32 *pCount)
	The number of attribute forms in this collection.
HRESULT	Item ([in] VARIANT *pIndex,[out, retval] IDSSAttributeInfo ppAttributeInfo)
	Access members.
HRESULT	Remove ([in] VARIANT *pMember)
	Delete a member from the collection.

---

Member Function Documentation

HRESULT IDSSAttributeInfos::_NewEnum (  [out, retval] IUnknown   pp_NewEnum  )

Enumerator for this collection. This is the standard property used to return the objects in a collection. It actually returns an enumerator object. Calling methods on the enumerator object retrieves the contents of the collection. After the enumerator object has been obtained, it is possible for both the members of the collection to change. The effect of this change on the members of the collection that are returned by the enumeration object is implementation dependent. Note that the user doesn't retrieve the contents of the collection until he or she calls the Next method on the enumerator object. This property does not presuppose that all of the objects are retrieved simultaneously. Parameters: pp_NewEnum  An IUnknown pointer to the enumerator object. The object is actually returned using the standard IEnumVARIANT interface. Returns: Usual COM result code: S_OK

HRESULT IDSSAttributeInfos::Add (  [in] IDSSAttribute *  pAttribute, [out, retval] IDSSAttributeInfo   ppAttributeInfo )

Insert a new AttributeInfo into the collection. Insert information about a new attribute into this collection. This method returns a reference to the attribute information object that it inserts so that the user can define properties on it. If the collection already contains information about this attribute, then a new reference to the existing attribute info object is returned. Parameters: pAttribute  The attribute with information to be stored. ppAttributeInfo  A reference to the new IDSSAttributeInfo object. Returns: Usual COM result code: S_OK

HRESULT IDSSAttributeInfos::Clear (   )

Empty the collection. Removes and deletes all objects from this collection. It is an error to call a method on attribute info from this collection after it has been removed by calling Clear. Returns: Usual COM result code: S_OK

HRESULT IDSSAttributeInfos::Count (  [out, retval] Int32 *  pCount  )

The number of attribute forms in this collection. Returns the number of objects in this collection. Parameters: pCount  The number of objects in this collection. Returns: Usual COM result code: S_OK

HRESULT IDSSAttributeInfos::Item (  [in] VARIANT *  pIndex, [out, retval] IDSSAttributeInfo   ppAttributeInfo )

Access members. They can be accessed by attribute.. Return an attribute form from the collection. The required form may be specified in several ways. Parameters: pIndex  Number = index number into the collection of the desired AttributeInfo. String = ID of the required attribute. Pointer = reference to an IDSSAttribute object. ppAttributeInfo  The attribute info retrieved from the collection. NULL if no object in the collection fits the pIndex parameter. Returns: Usual COM result code: S_OK

HRESULT IDSSAttributeInfos::Remove (  [in] VARIANT *  pMember  )

Delete a member from the collection. Remove an object from the collection. The object to be removed can be referred to in several different ways depending on the type used in the VARIANT argument. It is an error to attempt to call any methods on an object after it has been removed from this collection. Parameters: pMember  Number = index number into the collection of the desired AttributeInfo String = ID of the required attribute Pointer = reference to an IDSSAttribute object Returns: Usual COM result code: S_OK

---