Export (0) Print
Expand All

InkDisp.Dirty property

Applies to: desktop apps only

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

This property is read/write.

Syntax

HRESULT put_Dirty(
  [in]           VARIANT_BOOL Dirty
);

HRESULT get_Dirty(
  [out, retval]  VARIANT_BOOL *Dirty
);

Property value

VARIANT_TRUE to indicate that the ink has been modified; otherwise, VARIANT_FALSE.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The parameter pointer was NULL or invalid.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INK_INVALIDARG

The specified mode is invalid.

Remarks

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

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkDisp Class
Save Method

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft