Share via

3.1.4.13.2 Item (Opnum 4)

  • Article

The Item method is received by the server in an RPC_REQUEST packet. In response, the server returns an IAppHostElement for the specified index.

 [propget, id(DISPID_VALUE)] HRESULT Item(
   [in] VARIANT cIndex,
   [out, retval] IAppHostElement** ppElement
 );

cIndex: A VARIANT that specifies the IAppHostElement object to return from the collection. If the VARIANT is of type integer, the index is a zero-based index to the collection, where 0 indicates the first IAppHostElement, 1 the second, and so on. If the VARIANT is of type IAppHostElement, the index is a "selector" IAppHostElement to the specified collection.

ppElement: Contains the collection IAppHostElement.

Return Values: The server MUST return zero if it successfully processes the message that is received from the client. In this case, *ppElement is not NULL. If processing fails, the server MUST return a nonzero HRESULT code as defined in [MS-ERREF]. The following table describes the error conditions that MUST be handled and the corresponding error codes. A server MAY return additional implementation-specific error codes.

Return value/code

Description

0X00000000

NO_ERROR

The operation completed successfully.

0X80070057

ERROR_INVALID_PARAMETER

One or more parameters are incorrect or null.

0X80070585

ERROR_INVALID_INDEX

The integer index specified by cIndex is invalid, or the IAppHostElement specified by cIndex doesn’t match any element in the collection.