IDeskBand::GetBandInfo Method

---

Retrieves the information for a band object.

Syntax

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

Parameters

dwBandID

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

dwViewMode

View mode of the band object. This will be one of the following values:

DBIF_VIEWMODE_NORMAL	Band object is displayed in a horizontal band.
DBIF_VIEWMODE_VERTICAL	Band object is displayed in a vertical band.
DBIF_VIEWMODE_FLOATING	Band object is displayed in a floating band.
DBIF_VIEWMODE_TRANSPARENT	Band object is displayed in a transparent band.

pdbi

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

Return Value

Returns S_OK if successful, or an error code otherwise.