IShellLinkA::GetShowCmd method (shobjidl_core.h)

Article
02/22/2024

Gets the show command for a Shell link object.

Syntax

HRESULT GetShowCmd(
  int *piShowCmd
);

Parameters

piShowCmd

Type: int*

A pointer to the command. The following commands are supported.

SW_SHOWNORMAL

Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time.

SW_SHOWMAXIMIZED

Activates the window and displays it as a maximized window.

SW_SHOWMINIMIZED

Activates the window and displays it as a minimized window.

Return value

Type: HRESULT

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

Remarks

The show command is used to set the initial show state of the corresponding object. This is one of the SW_xxx values described in ShowWindow.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h
DLL	Shell32.dll (version 4.0 or later)