IResultData::FindItemByLParam

[This is preliminary documentation and subject to change.]

Enables the snap-in to find an item or subitem based on its user-inserted lParam value.

HRESULT FindItemByLParam(
  LPARAM lParam,         // Generic 32-bit value
  HRESULTITEM * pItemID  // Pointer to an item identifier
);
 

Parameters

lParam

[in] Generic 32-bit value in which information can be stored.

pItemID

[out] Pointer to an item identifier to hold the results of the search for the lParam value.

Return Values

S_OK

The item or subitem was successfully found.

S_FALSE

The item was not found.

E_UNEXPECTED

An unexpected error occurred.

E_INVALIDARG

The pItemID parameter is NULL.

Remarks

FindItemByLParam searches for an item based on its lParam. The unique identifier (cookie) of the first item in the list with a matching lParam is returned in pItemID. If no item is found, the search returns S_FALSE.

This method does not support virtual lists.

See Also

IResultData