Share via

IHomePluginEnvironment::InvalidatePlugin

  • Article

4/8/2010

The InvalidatePlugin method places a request to redraw the plug-in.

Syntax

HRESULT InvalidatePlugin (
  HPLUGIN hPlugin,
  DWORD dwFlags 
);

Parameters

  • hPlugin
    [in] Handle to the plug-in to be redrawn.

  • dwFlags
    [in] Indicates whether the height or selectability state of the plug-in has changed. If no flag is passed, the value must be 0; if either the height or the selectability of the plug-in changed, the value is IPF_HEIGHT_CHANGED | IPF_SELECTABILITY_CHANGED. (Both flags must be passed together, but only the flag that changed is read.) These flags are described in the following table.

    Flag Description

    IPF_HEIGHT_CHANGED

    Set this flag if the height of the plug-in changed. This flag causes the device to redraw the screen, a process that can drain the device battery quickly if repeated often.

    IPF_SELECTABILITY_CHANGED

    Set this flag if the selectability state of the plug-in changed. This flag causes the device to redraw the screen, a process that drains the device battery quickly if repeated often.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    Indicates success.

Requirements

Header home.h
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Smartphone 2002 and later

See Also

Reference

IHomePluginEnvironment