Share via

CListCtrl::GetBkImage

  • Article

Retrieves the current background image of a list view control.

BOOL GetBkImage( 
   LVBKIMAGE* plvbkImage  
) const;

Parameters

  • plvbkImage
    A pointer to an LVBKIMAGE structure containing the current background image of the list view.

Return Value

Returns nonzero if successful, or zero otherwise.

Remarks

This method implements the behavior of the Win32 macro, ListView_GetBkImage, as described in the Windows SDK.

Example

     LVBKIMAGE bki;

        // If no background image is set for the list view control use 
        // the Microsoft homepage image as the background image. 
        if (m_myListCtrl.GetBkImage(&bki) && (bki.ulFlags == LVBKIF_SOURCE_NONE))
        {
            m_myListCtrl.SetBkImage(
                _T("https://www.microsoft.com/library/images/gifs/homepage/microsoft.gif"),
                TRUE);
        }

Requirements

Header: afxcmn.h

See Also

Reference

CListCtrl Class

Hierarchy Chart

CListCtrl::SetBkImage