GetAndClearDirtyRange method

Retrieves and resets the dirty range associated with the given cookie.

Syntax


HRESULT retVal = object.GetAndClearDirtyRange(dwCookie, pIPointerBegin, pIPointerEnd);

Parameters

dwCookie [in]

Type: DWORD

DWORD that specifies the cookie, or identifier, given by the IMarkupContainer2::RegisterForDirtyRange method.

pIPointerBegin [in, optional]

Type: IMarkupPointer

Pointer to an IMarkupPointer interface that will be positioned at the beginning of the dirty range. If unneeded, set to NULL.

pIPointerEnd [in, optional]

Type: IMarkupPointer

Pointer to an IMarkupPointer interface that will be positioned at the end of the dirty range. If unneeded, set to NULL.

Return value

Type: HRESULT

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

Remarks

The client's dirty range is always cleared, with or without the markup pointer.

See also

Reference
IMarkupContainer2::RegisterForDirtyRange
IMarkupContainer2::UnRegisterForDirtyRange

 

 

Show: