IDeskBand::GetBandInfo method (shobjidl_core.h)

Article
02/22/2024

Gets state information for a band object.

Important You should use thumbnail toolbars in new development in place of desk bands, which are not supported as of Windows 7.

Syntax

HRESULT GetBandInfo(
  DWORD        dwBandID,
  DWORD        dwViewMode,
  DESKBANDINFO *pdbi
);

Parameters

dwBandID

Type: DWORD

The identifier of the band, assigned by the container. The band object can retain this value if it is required.

dwViewMode

Type: DWORD

The view mode of the band object. One of the following values:

DBIF_VIEWMODE_NORMAL

The band object is being displayed in a horizontal band.

DBIF_VIEWMODE_VERTICAL

The band object is being displayed in a vertical band.

DBIF_VIEWMODE_FLOATING

The band object is being displayed in a floating band.

DBIF_VIEWMODE_TRANSPARENT

The band object is being displayed in a transparent band.

pdbi

Type: DESKBANDINFO*

Pointer to a DESKBANDINFO structure that receives the band information for the object. The dwMask member of this structure indicates the specific information that is being requested.

Return value

Type: HRESULT

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

Requirements

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

Share via