GetBandInfo method

  • Article

Gets the information for a band object.

Syntax

HRESULT retVal = object.GetBandInfo(dwBandID, dwViewMode, pdbi);

Parameters

dwBandID

Type: DWORD

The identifier of the band. The container assigns this identifier. The band object can keep this value if it is required.

dwViewMode

Type: DWORD

The view mode of the band object. This is one of the following values.

DBIF_VIEWMODE_FLOATING

Band object is displayed in a floating band.

DBIF_VIEWMODE_NORMAL

Band object is displayed in a horizontal band.

DBIF_VIEWMODE_TRANSPARENT

Band object is displayed in a transparent band.

DBIF_VIEWMODE_VERTICAL

Band object is displayed in a vertical band.

pdbi

Type: DESKBANDINFO*

A pointer to a DESKBANDINFO structure that receives the band information for the object. The dwMask member of this structure indicates what information is requested.

Return value

Type: HRESULT

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