IDSSComments Interface Reference

Inherited by IDSSComments2.

List of all members.

---

Detailed Description

The interface IDSSComments is used to expose a collection of comments.

Each comment is a string value. The user can examine and alter this collection to annotate an object.

Public Member Functions
HRESULT	_NewEnum ([out, retval] IUnknown pp_NewEnum)
	Enumerator for this collection.
HRESULT	Add ([in] BSTR Comment)
	Insert a new comment string into the collection.
HRESULT	Count ([out, retval] Int32 *pCount)
	The number of comment strings in this collection.
HRESULT	Item ([in] Int32 Index,[out, retval] BSTR *pComment)
	Access members of the collection This is the default method of the interface.
HRESULT	Remove ([in] Int32 Index)
	Delete a comment string from the collection.

---

Member Function Documentation

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

Enumerator for this collection. This is the standard property used to return the strings 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 IDSSComments::Add (  [in] BSTR  Comment  )

Insert a new comment string into the collection. Parameters: Comment  String to be added to the comments collection. Returns: Usual COM result code: S_OK

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

The number of comment strings in this collection. Returns the number of comment strings in the collection. Parameters: pCount  The number of comment strings in the collection. Returns: Usual COM result code: S_OK

HRESULT IDSSComments::Item (  [in] Int32  Index, [out, retval] BSTR *  pComment )

Access members of the collection This is the default method of the interface. Return a comment string from the collection. Parameters: Index  Index to the collection. pComment  The requested member of the collection. NULL if none was found. Returns: Usual COM result code: S_OK E_INVALIDARG Index does not identify an element of the collection.

HRESULT IDSSComments::Remove (  [in] Int32  Index  )

Delete a comment string from the collection. Parameters: Index  The index of the element in the collection. Returns: Usual COM result code: S_OK E_INVALIDARG pIndex does not identify an element of the collection.

---