IExtendTaskPad::GetBackground method (mmc.h)

Article
02/22/2024

The IExtendTaskPad::GetBackground method enables MMC to get the taskpad's background image to display in taskpads that use MMC taskpad templates.

Syntax

HRESULT GetBackground(
  [in]  LPOLESTR                pszGroup,
  [out] MMC_TASK_DISPLAY_OBJECT *pTDO
);

Parameters

[in] pszGroup

A pointer to a null-terminated string that contains the group name that identifies the taskpad. The group name is the string that follows the hash (#) in the string passed in the ppViewType parameter when MMC calls IComponent::GetResultViewType to display the taskpad. If no group name is specified, pszGroup is a NULL string.

[out] pTDO

A pointer to an MMC_TASK_DISPLAY_OBJECT structure that the snap-in must fill in to specify the image to be displayed as the background for the taskpad specified by pszGroup.

Be aware that the caller (MMC) allocates the memory for the MMC_TASK_DISPLAY_OBJECT structure.

Return value

This method can return one of these values.

Remarks

Allocate the strings in the MMC_TASK_DISPLAY_BITMAP or MMC_TASK_DISPLAY_SYMBOL structure specified in the pTDO parameter with the COM API function CoTaskMemAlloc (or the equivalent) and MMC will release it.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	mmc.h