IDeskBand::GetBandInfo


		Contents Index Topic Contents
	Previous Topic: IDeskBand Next Topic: IDockingWindow

IDeskBand::GetBandInfo
HRESULT GetBandInfo(
    DWORD dwBandID, 
    DWORD dwViewMode, 
    DESKBANDINFO* pdbi
);
Retrieves the information for a band object.
Returns NOERROR if successful, or an OLE-defined error code otherwise.

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 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
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.

Version 4.71

Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.

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.