See Also
 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
4/8/2010
Gets a value that specifies whether ink is currently being drawn on an IInkOverlaycontrol.
Syntax
[propget] HRESULT get_CollectingInk ( [out, retval] VARIANT_BOOL *CollectingInk ); |
Parameters
- CollectingInk
-
Whether ink is currently being drawn on an ink collector.
If TRUE, ink is being drawn.
If FALSE, ink is not being drawn.
This property is read-only.
Return Value
| HRESULT value | Description |
|---|---|
|
S_OK |
Success. |
|
E_POINTER |
The CollectingInkparameter is an invalid pointer. |
|
E_INK_EXCEPTION |
An exception occurred inside the method. |
Remarks
You can use the CollectingInkproperty to see if ink is being drawn on an ink collector.
 Note: |
|---|
| Because ink collection is happening on a different thread than your application code, it is possible that the CollectingInkproperty can change soon after you have checked it. Thus, your code may be operating under the assumption that the ink collector is not collecting ink, when in fact it is. If this occurs, an error is thrown. To be safe, put such code in a try-catch block. |
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 |