3.1.4.11.2 Item (Opnum 4)

  • Article

The Item method is received by the server in an RPC_REQUEST packet. In response, the server returns the specified constant value.

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

cIndex: A VARIANT that represents the constant value to retrieve. If the VARIANT is of type integer, the index is a zero-based index to the collection of IAppHostElement objects, where 0 indicates the first IAppHostElement object, 1 the second, and so on. If the VARIANT is of type string, it is the name of the constant value.

ppConstantValue: Contains the constant value.

Return Values: The server MUST return zero if it successfully processes the message that is received from the client. In this case, *ppConstantValue 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 element with name specified by cIndex could not be found.

0X00000008

ERROR_NOT_ENOUGH_MEMORY

Not enough memory is available to process this command.