Share via

RegisterForDirtyRange method

  • Article

Registers a given IHTMLChangeSink interface to receive dirty range notification from the markup container.

Syntax

HRESULT retVal = object.RegisterForDirtyRange(pChangeSink, pdwCookie);

Parameters

  • pChangeSink [in]
    Type: IHTMLChangeSink

    Pointer to an IHTMLChangeSink interface that specifies the interface to register for change notifications.

  • pdwCookie [out]
    Type: DWORD

    Pointer to a variable of type DWORD that receives a cookie, or identifier, for use with this markup container.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

When you call this method, the markup container begins tracking the area where changes have occurred.

The cookie pdwCookie acts as an identifier during calls to IMarkupContainer2::UnRegisterForDirtyRange or IMarkupContainer2::GetAndClearDirtyRange to identify which dirty range the methods should work with.

See also

Reference

IMarkupContainer2::UnRegisterForDirtyRange

IMarkupContainer2::GetAndClearDirtyRange