INameSpaceTreeControlEvents::OnBeforeStateImageChange method (shobjidl.h)

Article
02/22/2024

Called before the state icon of the given IShellItem is changed.

Syntax

HRESULT OnBeforeStateImageChange(
  [in] IShellItem *psi
);

Parameters

[in] psi

Type: IShellItem*

Pointer to the IShellItem in which the state image is changing.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If this method returns S_OK, the client has processed the event and no further action is required of the namespace control. Otherwise the event will need to be processed, in this case the default action is to go to the next image in the list.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	shobjidl.h