IExplorerCommandState::GetState method (shobjidl_core.h)

Article
02/22/2024

Gets the command state associated with a specified Shell item.

Syntax

HRESULT GetState(
  [in]  IShellItemArray *psiItemArray,
  [in]  BOOL            fOkToBeSlow,
  [out] EXPCMDSTATE     *pCmdState
);

Parameters

[in] psiItemArray

Type: IShellItemArray*

A pointer to an IShellItemArray with a single element that represents the Shell item.

[in] fOkToBeSlow

Type: BOOL

FALSE if a verb object should not perform any memory intensive computations that could cause the UI thread to stop responding. The verb object should return E_PENDING in that case. If TRUE, those computations can be completed.

[out] pCmdState

Type: EXPCMDSTATE*

A pointer to a value that, when this method returns successfully, receives one or more Windows Explorer command states indicated by the EXPCMDSTATE constants.

Return value

Type: HRESULT

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

Remarks

This method provides the same functionality as GetState. Use IExplorerCommandState when you only need to know the command state.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)

Share via