IDSSStatements Interface Reference

List of all members.

---

Detailed Description

A DSS Request object stores the information needed by the server to perform a request.

A request is an instruction to the server to perform some action on behalf of some user. The actual request is stored within a script object (interface IDSSScript) and takes the form of a statement (interface IDSSStatement). To allow complex requests a statement may take the form of multiple statements that are to be executing in series or in parallel. Thus the statement object may contain a collection of statement objects.

This interface, IDSSStatements, is used to expose a collection of statement objects. It is returned by the Statements property of IDSSStatement.

This interface follows the usual collection conventions. The collection's members are numbered from one. The members of the collection are COM objects that expose the IDSSStatement object. Members cannot be shared between collections; nor can they exist independently of any collection. Instead the Add method creates a new member of the collection each time it is used.

Public Member Functions
HRESULT	_NewEnum ([out, retval] IUnknown pp_NewEnum)
	The usual VB enumerator.
HRESULT	Add ([in, optional, defaultvalue(NULL)] IDSSStatement *pStatement,[out, retval] IDSSStatement ppStatement)
	Add (by creating one) a new member to the collection.
HRESULT	Clear ()
	Remove all members from the collection.
HRESULT	Count ([out, retval] Int32 *pCount)
	The number of members in the collection.
HRESULT	Item ([in] VARIANT *Index,[out, retval] IDSSStatement ppStatement)
	Obtain a particular member of the collection.
HRESULT	Remove ([in] VARIANT *Index)
	Remove a member from the collection.

---

Member Function Documentation

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

The usual VB enumerator. This is the standard property used to return the objects in a collection. It returns an enumerator object. Calling methods on the enumerator object retrieves the contents of the collection. After the enumerator object is 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 does not 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 returned using the standard IEnumVARIANT interface. Returns: Usual COM result code: S_OK E_POINTER The memory of pp__NewEnum is not allocated before calling this method

HRESULT IDSSStatements::Add (  [in, optional, defaultvalue(NULL)] IDSSStatement *  pStatement, [out, retval] IDSSStatement   ppStatement )

Add (by creating one) a new member to the collection. This method adds a new member into the collection. Optionally the new member may be based upon an existing member of another collection, in which case a new member is created by copying out information from an existing member. The caller has the option to retrieve the freshly created member. Parameters: pStatement  The existed Statement to be added ppStatement  The pointer to the IDSSStatement interface Returns: Usual COM result code: S_OK E_POINTER The memory of ppStatement is not allocated before calling this method

HRESULT IDSSStatements::Clear (   )

Remove all members from the collection. This method removes all the members from the collection. Removing a member from the collection automatically deletes it. Returns: Usual COM result code: S_OK

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

The number of members in the collection. This method returns the number of members in the collection. Parameters: pCount  The number of members of the collection. Returns: Usual COM result code: S_OK E_POINTER The memory of pCount is not allocated before calling this method.

HRESULT IDSSStatements::Item (  [in] VARIANT *  Index, [out, retval] IDSSStatement   ppStatement )

Obtain a particular member of the collection. This call obtains a member from the collection. The member to be retrieved is identified with a Variant. A number in the range 1 to Count can be used to obtain a member by its position in the collection. Since Statement objects have names, an object can be referenced by name. Item is the default method of the interface. Parameters: Index  A VARIANT value that identifies the Statement to be found. Number = A value between 1 and Count. BSTR = The name of the member. ppStatement  The requested member of the collection. NULL if no member was found. Returns: Usual COM result code: S_OK E_INVALIDARG pIndex is NULL E_POINTER The memory of ppStatement is not allocated before calling this method DSSCOM_E_INDEX_OUT_OF_RANGE pIndex is a number not in the range 1 to Count. DSSCOM_E_BAD_ITEM_SPEC pIndex is not an expected type of Variant DSSCOM_E_KEY_NOT_FOUND pIndex is a string, but not the name of a member

HRESULT IDSSStatements::Remove (  [in] VARIANT *  Index  )

Remove a member from the collection. This method removes a member from the collection. The member to be removed is identified by a Variant. A number in the range 1 to Count can be used to obtain a member by its position in the collection. Since Statement objects have names, a member can be referenced by name. A pointer may also be used to identify the member. Removing a member from the collection automatically deletes it. Parameters: Index  A VARIANT value that identifies the Statement to be found. Number = A value between 1 and Count. BSTR = The name of the member. Returns: Usual COM result code: S_OK E_INVALIDARG pIndex is NULL. DSSCOM_E_INDEX_OUT_OF_RANGE pIndex is a number not in the range 1 to Count. DSSCOM_E_BAD_ITEM_SPEC pIndex is not an expected type of Variant. DSSCOM_E_KEY_NOT_FOUND pIndex is a string, but not the name of a member.

---