Share via


IInkDisp::Dirty

4/8/2010

Returns or sets the value that specifies whether the strokes of an IInkDisp object have been modified since the last time the ink was saved.

Syntax

[propput] HRESULT put_Dirty ([in] VARIANT_BOOL Dirty);
[propget] HRESULT get_Dirty ([out, retval] VARIANT_BOOL* Dirty);

Return Value

  • Dirty
    Returns or sets the Boolean value that specifies whether an IInkDisp object has been modified.

    This property is read/write.

    TRUE If the ink has been modified.

    False Default. If the ink has not been modified.

Return Value

  • S_OK
    Success.
  • E_POINTER
    The parameter pointer was NULL or invalid.
  • E_INK_EXCEPTION
    An exception occurred inside the method.
  • E_INVALIDARG
    The specified mode is invalid.

Remarks

After ink is saved, the dirty flag is automatically cleared and the value of this property is FALSE. To save ink, call the IInkDisp::Save method.

Requirements

Header msinkaut.h
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later

See Also

Concepts

Windows Mobile Ink Reference