IResultData::GetItem

[This is preliminary documentation and subject to change.]

Enables a user to retrieve the parameters of a single item.

HRESULT GetItem(
  LPRESULTDATAITEM item  // Pointer to a RESULTDATAITEM structure
);
 

Parameter

item
[in, out] Pointer to a RESULTDATAITEM structure containing information about the item whose parameters are being retrieved.
When applied to virtual lists, use the item index instead of the item ID, and set item ID = 0. Can only get select and focus states.

Return Values

S_OK
The item was successfully retrieved.
E_UNEXPECTED
An unexpected error occurred.
E_INVALIDARG
The pItem parameter is NULL.

Remarks

The itemID member of the RESULTDATAITEM structure pointed to by the item parameter should be set to refer to the item or subitem on which information is being returned. The nCol member should be set to zero because it is the only column in which anything can be obtained or set. In addition, the data members for each of the flags set in the mask member of the item structure if this method call succeeds.

If itemID is zero, the nIndex member can be used.

See Also

IResultData, IResultData::SetItem